diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 34aee328f4..4d9d8ee74c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,27 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.35.0 - 2020-03-30 +==================== + +Added +----- +* Support for the Vulnerability Scanning service +* Support for vSphere 7.0 in the VMware Solution service +* Support for forecasting in the Usage service +* Support for viewing, searching, and modifying parameters for on-premise Oracle databases in the Database Management service +* Support for listing tablespaces of managed databases in the Database Management service +* Support for cross-regional replication of keys in the Key Management service +* Support for highly-available database systems in the MySQL Database service +* Support for Oracle Enterprise Manager bridges, source auto-association, source event type mappings, and plugins to upload data in the Logging Analytics service + +Breaking +-------- +* Name of Enum attribute "forcast_type" in Usage API service renamed to "forecast_type" +* Value of Enum attribute "forecast_type" in Usage API service defaults to UNKNOWN_ENUM_VALUE when it receives an invalid value. In the earlier versions, this raises a ValueError +* Retries are now enabled in Upload Manager. The SDK used to explicitly override retry configuration on binary upload operations because of potential data corruption issue (https://github.com/oracle/oci-python-sdk/issues/203). + ==================== 2.34.0 - 2021-03-23 ==================== diff --git a/README.rst b/README.rst index a62b057167..d332d255b3 100644 --- a/README.rst +++ b/README.rst @@ -121,11 +121,20 @@ project's `GitHub repository`__. __ https://docs.cloud.oracle.com/Content/knownissues.htm __ https://github.com/oracle/oci-python-sdk +======= +Survey +======= + +Are you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you. +Click `here`__ for the survey page. + +__ https://oracle.questionpro.com/t/APeMlZka26?custom3=pypi + ======= License ======= -Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved. +Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. See `LICENSE`__ for more details. diff --git a/docs/api/database_management.rst b/docs/api/database_management.rst index 942f9d44bb..281a11d9b6 100644 --- a/docs/api/database_management.rst +++ b/docs/api/database_management.rst @@ -20,19 +20,27 @@ Database Management oci.database_management.models.ActivityTimeSeriesMetrics oci.database_management.models.AddManagedDatabaseToManagedDatabaseGroupDetails + oci.database_management.models.AllowedParameterValue + oci.database_management.models.ChangeDatabaseParameterDetails + oci.database_management.models.ChangeDatabaseParametersDetails oci.database_management.models.ChangeJobCompartmentDetails oci.database_management.models.ChangeManagedDatabaseGroupCompartmentDetails oci.database_management.models.ChildDatabase oci.database_management.models.CreateJobDetails oci.database_management.models.CreateManagedDatabaseGroupDetails oci.database_management.models.CreateSqlJobDetails + oci.database_management.models.DatabaseCredentials oci.database_management.models.DatabaseFleetHealthMetrics oci.database_management.models.DatabaseHomeMetricDefinition oci.database_management.models.DatabaseHomeMetrics oci.database_management.models.DatabaseIOAggregateMetrics + oci.database_management.models.DatabaseParameterSummary + oci.database_management.models.DatabaseParameterUpdateStatus + oci.database_management.models.DatabaseParametersCollection oci.database_management.models.DatabaseStorageAggregateMetrics oci.database_management.models.DatabaseTimeAggregateMetrics oci.database_management.models.DatabaseUsageMetrics + oci.database_management.models.Datafile oci.database_management.models.FleetMetricDefinition oci.database_management.models.FleetMetricSummaryDefinition oci.database_management.models.FleetStatusByCategory @@ -62,5 +70,10 @@ Database Management oci.database_management.models.ObjectStorageJobExecutionResultLocation oci.database_management.models.ParentGroup oci.database_management.models.RemoveManagedDatabaseFromManagedDatabaseGroupDetails + oci.database_management.models.ResetDatabaseParametersDetails oci.database_management.models.SqlJob + oci.database_management.models.Tablespace + oci.database_management.models.TablespaceCollection + oci.database_management.models.TablespaceSummary + oci.database_management.models.UpdateDatabaseParametersResult oci.database_management.models.UpdateManagedDatabaseGroupDetails diff --git a/docs/api/database_management/models/oci.database_management.models.AllowedParameterValue.rst b/docs/api/database_management/models/oci.database_management.models.AllowedParameterValue.rst new file mode 100644 index 0000000000..8e4baa0df1 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.AllowedParameterValue.rst @@ -0,0 +1,11 @@ +AllowedParameterValue +===================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: AllowedParameterValue + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParameterDetails.rst b/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParameterDetails.rst new file mode 100644 index 0000000000..8fd1b96b70 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParameterDetails.rst @@ -0,0 +1,11 @@ +ChangeDatabaseParameterDetails +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ChangeDatabaseParameterDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParametersDetails.rst b/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParametersDetails.rst new file mode 100644 index 0000000000..d5876c0300 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ChangeDatabaseParametersDetails.rst @@ -0,0 +1,11 @@ +ChangeDatabaseParametersDetails +=============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ChangeDatabaseParametersDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DatabaseCredentials.rst b/docs/api/database_management/models/oci.database_management.models.DatabaseCredentials.rst new file mode 100644 index 0000000000..07470cb4ca --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DatabaseCredentials.rst @@ -0,0 +1,11 @@ +DatabaseCredentials +=================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DatabaseCredentials + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DatabaseParameterSummary.rst b/docs/api/database_management/models/oci.database_management.models.DatabaseParameterSummary.rst new file mode 100644 index 0000000000..7bcf6e306e --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DatabaseParameterSummary.rst @@ -0,0 +1,11 @@ +DatabaseParameterSummary +======================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DatabaseParameterSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DatabaseParameterUpdateStatus.rst b/docs/api/database_management/models/oci.database_management.models.DatabaseParameterUpdateStatus.rst new file mode 100644 index 0000000000..5ab82bca20 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DatabaseParameterUpdateStatus.rst @@ -0,0 +1,11 @@ +DatabaseParameterUpdateStatus +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DatabaseParameterUpdateStatus + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DatabaseParametersCollection.rst b/docs/api/database_management/models/oci.database_management.models.DatabaseParametersCollection.rst new file mode 100644 index 0000000000..56718d4667 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DatabaseParametersCollection.rst @@ -0,0 +1,11 @@ +DatabaseParametersCollection +============================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DatabaseParametersCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.Datafile.rst b/docs/api/database_management/models/oci.database_management.models.Datafile.rst new file mode 100644 index 0000000000..1bddfbfeeb --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.Datafile.rst @@ -0,0 +1,11 @@ +Datafile +======== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: Datafile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ResetDatabaseParametersDetails.rst b/docs/api/database_management/models/oci.database_management.models.ResetDatabaseParametersDetails.rst new file mode 100644 index 0000000000..1e04a2eb64 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ResetDatabaseParametersDetails.rst @@ -0,0 +1,11 @@ +ResetDatabaseParametersDetails +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ResetDatabaseParametersDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.Tablespace.rst b/docs/api/database_management/models/oci.database_management.models.Tablespace.rst new file mode 100644 index 0000000000..dc14e4b1ce --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.Tablespace.rst @@ -0,0 +1,11 @@ +Tablespace +========== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: Tablespace + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.TablespaceCollection.rst b/docs/api/database_management/models/oci.database_management.models.TablespaceCollection.rst new file mode 100644 index 0000000000..013087ee3a --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.TablespaceCollection.rst @@ -0,0 +1,11 @@ +TablespaceCollection +==================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: TablespaceCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.TablespaceSummary.rst b/docs/api/database_management/models/oci.database_management.models.TablespaceSummary.rst new file mode 100644 index 0000000000..7b4bbebf9c --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.TablespaceSummary.rst @@ -0,0 +1,11 @@ +TablespaceSummary +================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: TablespaceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.UpdateDatabaseParametersResult.rst b/docs/api/database_management/models/oci.database_management.models.UpdateDatabaseParametersResult.rst new file mode 100644 index 0000000000..61b036ffb1 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.UpdateDatabaseParametersResult.rst @@ -0,0 +1,11 @@ +UpdateDatabaseParametersResult +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: UpdateDatabaseParametersResult + :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 bc0fe36b4e..4f45306f16 100644 --- a/docs/api/key_management.rst +++ b/docs/api/key_management.rst @@ -31,8 +31,10 @@ Key Management oci.key_management.models.ChangeVaultCompartmentDetails oci.key_management.models.CreateKeyDetails oci.key_management.models.CreateVaultDetails + oci.key_management.models.CreateVaultReplicaDetails oci.key_management.models.DecryptDataDetails oci.key_management.models.DecryptedData + oci.key_management.models.DeleteVaultReplicaDetails oci.key_management.models.EncryptDataDetails oci.key_management.models.EncryptedData oci.key_management.models.ExportKeyDetails @@ -42,10 +44,14 @@ Key Management oci.key_management.models.ImportKeyDetails oci.key_management.models.ImportKeyVersionDetails oci.key_management.models.Key + oci.key_management.models.KeyReplicaDetails oci.key_management.models.KeyShape oci.key_management.models.KeySummary oci.key_management.models.KeyVersion + oci.key_management.models.KeyVersionReplicaDetails oci.key_management.models.KeyVersionSummary + oci.key_management.models.ReplicaDetails + oci.key_management.models.ReplicationStatusDetails oci.key_management.models.RestoreKeyFromObjectStoreDetails oci.key_management.models.RestoreVaultFromObjectStoreDetails oci.key_management.models.ScheduleKeyDeletionDetails @@ -56,6 +62,8 @@ Key Management oci.key_management.models.UpdateKeyDetails oci.key_management.models.UpdateVaultDetails oci.key_management.models.Vault + oci.key_management.models.VaultReplicaDetails + oci.key_management.models.VaultReplicaSummary oci.key_management.models.VaultSummary oci.key_management.models.VaultUsage oci.key_management.models.VerifiedData diff --git a/docs/api/key_management/models/oci.key_management.models.CreateVaultReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.CreateVaultReplicaDetails.rst new file mode 100644 index 0000000000..72d84c92af --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.CreateVaultReplicaDetails.rst @@ -0,0 +1,11 @@ +CreateVaultReplicaDetails +========================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: CreateVaultReplicaDetails + :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.DeleteVaultReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.DeleteVaultReplicaDetails.rst new file mode 100644 index 0000000000..8368d8d69f --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.DeleteVaultReplicaDetails.rst @@ -0,0 +1,11 @@ +DeleteVaultReplicaDetails +========================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: DeleteVaultReplicaDetails + :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.KeyReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.KeyReplicaDetails.rst new file mode 100644 index 0000000000..af908856f6 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.KeyReplicaDetails.rst @@ -0,0 +1,11 @@ +KeyReplicaDetails +================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: KeyReplicaDetails + :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.KeyVersionReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.KeyVersionReplicaDetails.rst new file mode 100644 index 0000000000..cf57ee44d3 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.KeyVersionReplicaDetails.rst @@ -0,0 +1,11 @@ +KeyVersionReplicaDetails +======================== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: KeyVersionReplicaDetails + :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.ReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.ReplicaDetails.rst new file mode 100644 index 0000000000..2c5c4711be --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.ReplicaDetails.rst @@ -0,0 +1,11 @@ +ReplicaDetails +============== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: ReplicaDetails + :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.ReplicationStatusDetails.rst b/docs/api/key_management/models/oci.key_management.models.ReplicationStatusDetails.rst new file mode 100644 index 0000000000..7e2698a9dd --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.ReplicationStatusDetails.rst @@ -0,0 +1,11 @@ +ReplicationStatusDetails +======================== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: ReplicationStatusDetails + :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.VaultReplicaDetails.rst b/docs/api/key_management/models/oci.key_management.models.VaultReplicaDetails.rst new file mode 100644 index 0000000000..a1ed94dbdd --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.VaultReplicaDetails.rst @@ -0,0 +1,11 @@ +VaultReplicaDetails +=================== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: VaultReplicaDetails + :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.VaultReplicaSummary.rst b/docs/api/key_management/models/oci.key_management.models.VaultReplicaSummary.rst new file mode 100644 index 0000000000..c187ede91d --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.VaultReplicaSummary.rst @@ -0,0 +1,11 @@ +VaultReplicaSummary +=================== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: VaultReplicaSummary + :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 731a26553f..95fb3f7f03 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -105,6 +105,7 @@ API Reference * :doc:`Work Request ` * :doc:`Usageapi ` * :doc:`Vaults ` +* :doc:`Vulnerability Scanning ` * :doc:`Redirect ` * :doc:`Waas ` * :doc:`Work Request ` @@ -192,6 +193,7 @@ API Reference tenant_manager_control_plane usage_api vault + vulnerability_scanning waas work_requests config diff --git a/docs/api/log_analytics.rst b/docs/api/log_analytics.rst index 0cec5ecd5f..3becd3a1d7 100644 --- a/docs/api/log_analytics.rst +++ b/docs/api/log_analytics.rst @@ -28,11 +28,16 @@ Log Analytics oci.log_analytics.models.AddFieldsCommandDescriptor oci.log_analytics.models.ArchivingConfiguration oci.log_analytics.models.Argument + oci.log_analytics.models.AssociableEntity + oci.log_analytics.models.AssociableEntityCollection oci.log_analytics.models.AssociationSummaryReport + oci.log_analytics.models.AutoAssociationCollection + oci.log_analytics.models.AutoAssociationState oci.log_analytics.models.AutoLookups oci.log_analytics.models.BottomCommandDescriptor oci.log_analytics.models.BucketCommandDescriptor oci.log_analytics.models.BucketRange + oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails oci.log_analytics.models.ChangeLogAnalyticsEntityCompartmentDetails oci.log_analytics.models.ChangeLogAnalyticsLogGroupCompartmentDetails oci.log_analytics.models.ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails @@ -51,6 +56,7 @@ Log Analytics oci.log_analytics.models.ColumnNameCollection oci.log_analytics.models.CommandDescriptor oci.log_analytics.models.CreateAccelerationTaskDetails + oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails oci.log_analytics.models.CreateLogAnalyticsEntityDetails oci.log_analytics.models.CreateLogAnalyticsEntityTypeDetails oci.log_analytics.models.CreateLogAnalyticsLogGroupDetails @@ -58,14 +64,19 @@ Log Analytics oci.log_analytics.models.CreateScheduledTaskDetails oci.log_analytics.models.CreateStandardTaskDetails oci.log_analytics.models.CreateViewCommandDescriptor + oci.log_analytics.models.CreationSource oci.log_analytics.models.CronSchedule oci.log_analytics.models.DeleteCommandDescriptor oci.log_analytics.models.DeleteLogAnalyticsAssociation oci.log_analytics.models.DeleteLogAnalyticsAssociationDetails oci.log_analytics.models.DeltaCommandDescriptor oci.log_analytics.models.DemoModeCommandDescriptor + oci.log_analytics.models.DisableAutoAssociationDetail + oci.log_analytics.models.DisableAutoAssociationDetails oci.log_analytics.models.DistinctCommandDescriptor oci.log_analytics.models.EfdRegexResult + oci.log_analytics.models.EnableAutoAssociationDetail + oci.log_analytics.models.EnableAutoAssociationDetails oci.log_analytics.models.EntityTypeProperty oci.log_analytics.models.ErrorDetails oci.log_analytics.models.EstimatePurgeDataSizeDetails @@ -77,6 +88,8 @@ Log Analytics oci.log_analytics.models.EvalCommandDescriptor oci.log_analytics.models.EventStatsCommandDescriptor oci.log_analytics.models.EventType + oci.log_analytics.models.EventTypeCollection + oci.log_analytics.models.EventTypeDetails oci.log_analytics.models.ExportContent oci.log_analytics.models.ExportDetails oci.log_analytics.models.ExtendedFieldsValidationResult @@ -121,6 +134,10 @@ Log Analytics oci.log_analytics.models.LogAnalyticsConfigWorkRequestCollection oci.log_analytics.models.LogAnalyticsConfigWorkRequestPayload oci.log_analytics.models.LogAnalyticsConfigWorkRequestSummary + oci.log_analytics.models.LogAnalyticsEmBridge + oci.log_analytics.models.LogAnalyticsEmBridgeCollection + oci.log_analytics.models.LogAnalyticsEmBridgeSummary + oci.log_analytics.models.LogAnalyticsEmBridgeSummaryReport oci.log_analytics.models.LogAnalyticsEntity oci.log_analytics.models.LogAnalyticsEntityCollection oci.log_analytics.models.LogAnalyticsEntitySummary @@ -186,8 +203,10 @@ Log Analytics oci.log_analytics.models.LogAnalyticsWarning oci.log_analytics.models.LogAnalyticsWarningCollection oci.log_analytics.models.LogGroupSummaryReport + oci.log_analytics.models.LogSetCollection oci.log_analytics.models.LookupCommandDescriptor oci.log_analytics.models.LookupField + oci.log_analytics.models.LookupSummaryReport oci.log_analytics.models.MacroCommandDescriptor oci.log_analytics.models.MapCommandDescriptor oci.log_analytics.models.MatchInfo @@ -257,6 +276,7 @@ Log Analytics oci.log_analytics.models.TopCommandDescriptor oci.log_analytics.models.TrendColumn oci.log_analytics.models.UiParserTestMetadata + oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails oci.log_analytics.models.UpdateLogAnalyticsEntityDetails oci.log_analytics.models.UpdateLogAnalyticsEntityTypeDetails oci.log_analytics.models.UpdateLogAnalyticsLogGroupDetails diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntity.rst b/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntity.rst new file mode 100644 index 0000000000..d7f421756d --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntity.rst @@ -0,0 +1,11 @@ +AssociableEntity +================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: AssociableEntity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntityCollection.rst b/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntityCollection.rst new file mode 100644 index 0000000000..140fedd645 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.AssociableEntityCollection.rst @@ -0,0 +1,11 @@ +AssociableEntityCollection +========================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: AssociableEntityCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationCollection.rst b/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationCollection.rst new file mode 100644 index 0000000000..dd79a32c68 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationCollection.rst @@ -0,0 +1,11 @@ +AutoAssociationCollection +========================= + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: AutoAssociationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationState.rst b/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationState.rst new file mode 100644 index 0000000000..af83026dd1 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.AutoAssociationState.rst @@ -0,0 +1,11 @@ +AutoAssociationState +==================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: AutoAssociationState + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails.rst new file mode 100644 index 0000000000..e5e2a4f010 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeLogAnalyticsEmBridgeCompartmentDetails +============================================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: ChangeLogAnalyticsEmBridgeCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails.rst new file mode 100644 index 0000000000..5030e24c5e --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails.rst @@ -0,0 +1,11 @@ +CreateLogAnalyticsEmBridgeDetails +================================= + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: CreateLogAnalyticsEmBridgeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.CreationSource.rst b/docs/api/log_analytics/models/oci.log_analytics.models.CreationSource.rst new file mode 100644 index 0000000000..b65e7fa1d6 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.CreationSource.rst @@ -0,0 +1,11 @@ +CreationSource +============== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: CreationSource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetail.rst b/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetail.rst new file mode 100644 index 0000000000..ffe596f4cf --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetail.rst @@ -0,0 +1,11 @@ +DisableAutoAssociationDetail +============================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: DisableAutoAssociationDetail + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetails.rst new file mode 100644 index 0000000000..6884b929a5 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.DisableAutoAssociationDetails.rst @@ -0,0 +1,11 @@ +DisableAutoAssociationDetails +============================= + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: DisableAutoAssociationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetail.rst b/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetail.rst new file mode 100644 index 0000000000..c56eef7f65 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetail.rst @@ -0,0 +1,11 @@ +EnableAutoAssociationDetail +=========================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: EnableAutoAssociationDetail + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetails.rst new file mode 100644 index 0000000000..ce7b825afb --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.EnableAutoAssociationDetails.rst @@ -0,0 +1,11 @@ +EnableAutoAssociationDetails +============================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: EnableAutoAssociationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeCollection.rst b/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeCollection.rst new file mode 100644 index 0000000000..a1ec106113 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeCollection.rst @@ -0,0 +1,11 @@ +EventTypeCollection +=================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: EventTypeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeDetails.rst new file mode 100644 index 0000000000..4f5ed6dbdd --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.EventTypeDetails.rst @@ -0,0 +1,11 @@ +EventTypeDetails +================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: EventTypeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridge.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridge.rst new file mode 100644 index 0000000000..f9654e48b7 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridge.rst @@ -0,0 +1,11 @@ +LogAnalyticsEmBridge +==================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LogAnalyticsEmBridge + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeCollection.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeCollection.rst new file mode 100644 index 0000000000..9d7b9efdb1 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeCollection.rst @@ -0,0 +1,11 @@ +LogAnalyticsEmBridgeCollection +============================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LogAnalyticsEmBridgeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummary.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummary.rst new file mode 100644 index 0000000000..3f5e427e60 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummary.rst @@ -0,0 +1,11 @@ +LogAnalyticsEmBridgeSummary +=========================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LogAnalyticsEmBridgeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummaryReport.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummaryReport.rst new file mode 100644 index 0000000000..734e251dad --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LogAnalyticsEmBridgeSummaryReport.rst @@ -0,0 +1,11 @@ +LogAnalyticsEmBridgeSummaryReport +================================= + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LogAnalyticsEmBridgeSummaryReport + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LogSetCollection.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LogSetCollection.rst new file mode 100644 index 0000000000..94ccc4563c --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LogSetCollection.rst @@ -0,0 +1,11 @@ +LogSetCollection +================ + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LogSetCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.LookupSummaryReport.rst b/docs/api/log_analytics/models/oci.log_analytics.models.LookupSummaryReport.rst new file mode 100644 index 0000000000..fb5ad95124 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.LookupSummaryReport.rst @@ -0,0 +1,11 @@ +LookupSummaryReport +=================== + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: LookupSummaryReport + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/log_analytics/models/oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails.rst b/docs/api/log_analytics/models/oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails.rst new file mode 100644 index 0000000000..9563e8f2d3 --- /dev/null +++ b/docs/api/log_analytics/models/oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails.rst @@ -0,0 +1,11 @@ +UpdateLogAnalyticsEmBridgeDetails +================================= + +.. currentmodule:: oci.log_analytics.models + +.. autoclass:: UpdateLogAnalyticsEmBridgeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/mysql.rst b/docs/api/mysql.rst index 96e8168e8a..7a053986a9 100644 --- a/docs/api/mysql.rst +++ b/docs/api/mysql.rst @@ -63,6 +63,7 @@ Mysql oci.mysql.models.CreateMaintenanceDetails oci.mysql.models.DbSystem oci.mysql.models.DbSystemEndpoint + oci.mysql.models.DbSystemPlacement oci.mysql.models.DbSystemSnapshot oci.mysql.models.DbSystemSource oci.mysql.models.DbSystemSourceFromBackup diff --git a/docs/api/mysql/models/oci.mysql.models.DbSystemPlacement.rst b/docs/api/mysql/models/oci.mysql.models.DbSystemPlacement.rst new file mode 100644 index 0000000000..95bd6fcdff --- /dev/null +++ b/docs/api/mysql/models/oci.mysql.models.DbSystemPlacement.rst @@ -0,0 +1,11 @@ +DbSystemPlacement +================= + +.. currentmodule:: oci.mysql.models + +.. autoclass:: DbSystemPlacement + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning.rst b/docs/api/vulnerability_scanning.rst new file mode 100644 index 0000000000..e3a4a21942 --- /dev/null +++ b/docs/api/vulnerability_scanning.rst @@ -0,0 +1,98 @@ +Vulnerability Scanning +====================== + +.. autosummary:: + :toctree: vulnerability_scanning/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.vulnerability_scanning.VulnerabilityScanningClient + oci.vulnerability_scanning.VulnerabilityScanningClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: vulnerability_scanning/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.vulnerability_scanning.models.ChangeContainerScanRecipeCompartmentDetails + oci.vulnerability_scanning.models.ChangeContainerScanResultCompartmentDetails + oci.vulnerability_scanning.models.ChangeContainerScanTargetCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostAgentScanResultCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostCisBenchmarkScanResultCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostEndpointProtectionScanResultCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostPortScanResultCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostScanRecipeCompartmentDetails + oci.vulnerability_scanning.models.ChangeHostScanTargetCompartmentDetails + oci.vulnerability_scanning.models.ContainerScanRecipe + oci.vulnerability_scanning.models.ContainerScanRecipeSummary + oci.vulnerability_scanning.models.ContainerScanRecipeSummaryCollection + oci.vulnerability_scanning.models.ContainerScanRegistry + oci.vulnerability_scanning.models.ContainerScanResult + oci.vulnerability_scanning.models.ContainerScanResultProblem + oci.vulnerability_scanning.models.ContainerScanResultSummary + oci.vulnerability_scanning.models.ContainerScanResultSummaryCollection + oci.vulnerability_scanning.models.ContainerScanSettings + oci.vulnerability_scanning.models.ContainerScanTarget + oci.vulnerability_scanning.models.ContainerScanTargetSummary + oci.vulnerability_scanning.models.ContainerScanTargetSummaryCollection + oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails + oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails + oci.vulnerability_scanning.models.CreateContainerScanTargetDetails + oci.vulnerability_scanning.models.CreateHostScanRecipeDetails + oci.vulnerability_scanning.models.CreateHostScanTargetDetails + oci.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails + oci.vulnerability_scanning.models.CveDetails + oci.vulnerability_scanning.models.ExportHostAgentScanResultCsvDetails + oci.vulnerability_scanning.models.ExportHostVulnerabilityCsvDetails + oci.vulnerability_scanning.models.HostAgentScanResult + oci.vulnerability_scanning.models.HostAgentScanResultProblem + oci.vulnerability_scanning.models.HostAgentScanResultSummary + oci.vulnerability_scanning.models.HostAgentScanResultSummaryCollection + oci.vulnerability_scanning.models.HostCisBenchmarkScanResult + oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore + oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary + oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummaryCollection + oci.vulnerability_scanning.models.HostCisBenchmarkSettings + oci.vulnerability_scanning.models.HostEndpointProtectionScanResult + oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection + oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary + oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummaryCollection + oci.vulnerability_scanning.models.HostEndpointProtectionSettings + oci.vulnerability_scanning.models.HostPortScanResult + oci.vulnerability_scanning.models.HostPortScanResultOpenPort + oci.vulnerability_scanning.models.HostPortScanResultSummary + oci.vulnerability_scanning.models.HostPortScanResultSummaryCollection + oci.vulnerability_scanning.models.HostScanAgentConfiguration + oci.vulnerability_scanning.models.HostScanAgentConfigurationOCI + oci.vulnerability_scanning.models.HostScanAgentSettings + oci.vulnerability_scanning.models.HostScanPortSettings + oci.vulnerability_scanning.models.HostScanRecipe + oci.vulnerability_scanning.models.HostScanRecipeSummary + oci.vulnerability_scanning.models.HostScanRecipeSummaryCollection + oci.vulnerability_scanning.models.HostScanTarget + oci.vulnerability_scanning.models.HostScanTargetSummary + oci.vulnerability_scanning.models.HostScanTargetSummaryCollection + oci.vulnerability_scanning.models.HostVulnerability + oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary + oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummaryCollection + oci.vulnerability_scanning.models.HostVulnerabilitySummary + oci.vulnerability_scanning.models.HostVulnerabilitySummaryCollection + oci.vulnerability_scanning.models.OcirContainerScanRegistry + oci.vulnerability_scanning.models.Schedule + oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails + oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails + oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails + oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails + oci.vulnerability_scanning.models.UpdateHostScanTargetDetails + oci.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails + oci.vulnerability_scanning.models.WorkRequest + oci.vulnerability_scanning.models.WorkRequestCollection + oci.vulnerability_scanning.models.WorkRequestError + oci.vulnerability_scanning.models.WorkRequestErrorCollection + oci.vulnerability_scanning.models.WorkRequestLogEntry + oci.vulnerability_scanning.models.WorkRequestLogEntryCollection + oci.vulnerability_scanning.models.WorkRequestResource diff --git a/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClient.rst b/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClient.rst new file mode 100644 index 0000000000..ba629ee36e --- /dev/null +++ b/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClient.rst @@ -0,0 +1,8 @@ +VulnerabilityScanningClient +=========================== + +.. currentmodule:: oci.vulnerability_scanning + +.. autoclass:: VulnerabilityScanningClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClientCompositeOperations.rst b/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClientCompositeOperations.rst new file mode 100644 index 0000000000..3816be5a31 --- /dev/null +++ b/docs/api/vulnerability_scanning/client/oci.vulnerability_scanning.VulnerabilityScanningClientCompositeOperations.rst @@ -0,0 +1,8 @@ +VulnerabilityScanningClientCompositeOperations +============================================== + +.. currentmodule:: oci.vulnerability_scanning + +.. autoclass:: VulnerabilityScanningClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanRecipeCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanRecipeCompartmentDetails.rst new file mode 100644 index 0000000000..83da7f13d3 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanRecipeCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeContainerScanRecipeCompartmentDetails +=========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeContainerScanRecipeCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanResultCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanResultCompartmentDetails.rst new file mode 100644 index 0000000000..0c16835d5f --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanResultCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeContainerScanResultCompartmentDetails +=========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeContainerScanResultCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanTargetCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanTargetCompartmentDetails.rst new file mode 100644 index 0000000000..417aef88a4 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeContainerScanTargetCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeContainerScanTargetCompartmentDetails +=========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeContainerScanTargetCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostAgentScanResultCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostAgentScanResultCompartmentDetails.rst new file mode 100644 index 0000000000..f9a5f0e479 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostAgentScanResultCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostAgentScanResultCompartmentDetails +=========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostAgentScanResultCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostCisBenchmarkScanResultCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostCisBenchmarkScanResultCompartmentDetails.rst new file mode 100644 index 0000000000..61554dd2a0 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostCisBenchmarkScanResultCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostCisBenchmarkScanResultCompartmentDetails +================================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostCisBenchmarkScanResultCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostEndpointProtectionScanResultCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostEndpointProtectionScanResultCompartmentDetails.rst new file mode 100644 index 0000000000..29b0e3d6fe --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostEndpointProtectionScanResultCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostEndpointProtectionScanResultCompartmentDetails +======================================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostEndpointProtectionScanResultCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostPortScanResultCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostPortScanResultCompartmentDetails.rst new file mode 100644 index 0000000000..02854c821b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostPortScanResultCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostPortScanResultCompartmentDetails +========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostPortScanResultCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanRecipeCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanRecipeCompartmentDetails.rst new file mode 100644 index 0000000000..404fdb307b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanRecipeCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostScanRecipeCompartmentDetails +====================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostScanRecipeCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanTargetCompartmentDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanTargetCompartmentDetails.rst new file mode 100644 index 0000000000..fd95959639 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ChangeHostScanTargetCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeHostScanTargetCompartmentDetails +====================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ChangeHostScanTargetCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipe.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipe.rst new file mode 100644 index 0000000000..9afc1ac961 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipe.rst @@ -0,0 +1,11 @@ +ContainerScanRecipe +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanRecipe + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummary.rst new file mode 100644 index 0000000000..9b460bbcf6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummary.rst @@ -0,0 +1,11 @@ +ContainerScanRecipeSummary +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanRecipeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummaryCollection.rst new file mode 100644 index 0000000000..209344e1aa --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRecipeSummaryCollection.rst @@ -0,0 +1,11 @@ +ContainerScanRecipeSummaryCollection +==================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanRecipeSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRegistry.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRegistry.rst new file mode 100644 index 0000000000..793ed5d70b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanRegistry.rst @@ -0,0 +1,11 @@ +ContainerScanRegistry +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanRegistry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResult.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResult.rst new file mode 100644 index 0000000000..fc40ccf2f2 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResult.rst @@ -0,0 +1,11 @@ +ContainerScanResult +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultProblem.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultProblem.rst new file mode 100644 index 0000000000..8c83b9f0d6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultProblem.rst @@ -0,0 +1,11 @@ +ContainerScanResultProblem +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanResultProblem + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummary.rst new file mode 100644 index 0000000000..f87fe88e96 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummary.rst @@ -0,0 +1,11 @@ +ContainerScanResultSummary +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanResultSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummaryCollection.rst new file mode 100644 index 0000000000..50e34e23a4 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanResultSummaryCollection.rst @@ -0,0 +1,11 @@ +ContainerScanResultSummaryCollection +==================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanResultSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanSettings.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanSettings.rst new file mode 100644 index 0000000000..7096b60336 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanSettings.rst @@ -0,0 +1,11 @@ +ContainerScanSettings +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanSettings + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTarget.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTarget.rst new file mode 100644 index 0000000000..92b69ebfcc --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTarget.rst @@ -0,0 +1,11 @@ +ContainerScanTarget +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanTarget + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummary.rst new file mode 100644 index 0000000000..639b087b06 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummary.rst @@ -0,0 +1,11 @@ +ContainerScanTargetSummary +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanTargetSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummaryCollection.rst new file mode 100644 index 0000000000..11caa0062a --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ContainerScanTargetSummaryCollection.rst @@ -0,0 +1,11 @@ +ContainerScanTargetSummaryCollection +==================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ContainerScanTargetSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails.rst new file mode 100644 index 0000000000..3772553161 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails.rst @@ -0,0 +1,11 @@ +CreateContainerScanRecipeDetails +================================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateContainerScanRecipeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails.rst new file mode 100644 index 0000000000..24c8e05efb --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails.rst @@ -0,0 +1,11 @@ +CreateContainerScanRegistryDetails +================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateContainerScanRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanTargetDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanTargetDetails.rst new file mode 100644 index 0000000000..f71e432f85 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateContainerScanTargetDetails.rst @@ -0,0 +1,11 @@ +CreateContainerScanTargetDetails +================================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateContainerScanTargetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanRecipeDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanRecipeDetails.rst new file mode 100644 index 0000000000..7cd485ba3d --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanRecipeDetails.rst @@ -0,0 +1,11 @@ +CreateHostScanRecipeDetails +=========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateHostScanRecipeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanTargetDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanTargetDetails.rst new file mode 100644 index 0000000000..69eb5633c6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateHostScanTargetDetails.rst @@ -0,0 +1,11 @@ +CreateHostScanTargetDetails +=========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateHostScanTargetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails.rst new file mode 100644 index 0000000000..8d5b1833f0 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails.rst @@ -0,0 +1,11 @@ +CreateOcirContainerScanRegistryDetails +====================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CreateOcirContainerScanRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CveDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CveDetails.rst new file mode 100644 index 0000000000..511fe6860b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.CveDetails.rst @@ -0,0 +1,11 @@ +CveDetails +========== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: CveDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostAgentScanResultCsvDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostAgentScanResultCsvDetails.rst new file mode 100644 index 0000000000..8c6e2f7fd3 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostAgentScanResultCsvDetails.rst @@ -0,0 +1,11 @@ +ExportHostAgentScanResultCsvDetails +=================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ExportHostAgentScanResultCsvDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostVulnerabilityCsvDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostVulnerabilityCsvDetails.rst new file mode 100644 index 0000000000..f80b696caa --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.ExportHostVulnerabilityCsvDetails.rst @@ -0,0 +1,11 @@ +ExportHostVulnerabilityCsvDetails +================================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: ExportHostVulnerabilityCsvDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResult.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResult.rst new file mode 100644 index 0000000000..2405045a8e --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResult.rst @@ -0,0 +1,11 @@ +HostAgentScanResult +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostAgentScanResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultProblem.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultProblem.rst new file mode 100644 index 0000000000..11658b35b0 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultProblem.rst @@ -0,0 +1,11 @@ +HostAgentScanResultProblem +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostAgentScanResultProblem + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummary.rst new file mode 100644 index 0000000000..988ef21ba8 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummary.rst @@ -0,0 +1,11 @@ +HostAgentScanResultSummary +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostAgentScanResultSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummaryCollection.rst new file mode 100644 index 0000000000..f8c4968209 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostAgentScanResultSummaryCollection.rst @@ -0,0 +1,11 @@ +HostAgentScanResultSummaryCollection +==================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostAgentScanResultSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResult.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResult.rst new file mode 100644 index 0000000000..1da2d6cfb1 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResult.rst @@ -0,0 +1,11 @@ +HostCisBenchmarkScanResult +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostCisBenchmarkScanResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore.rst new file mode 100644 index 0000000000..ff1a06d322 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore.rst @@ -0,0 +1,11 @@ +HostCisBenchmarkScanResultScore +=============================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostCisBenchmarkScanResultScore + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary.rst new file mode 100644 index 0000000000..9c969a7439 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary.rst @@ -0,0 +1,11 @@ +HostCisBenchmarkScanResultSummary +================================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostCisBenchmarkScanResultSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummaryCollection.rst new file mode 100644 index 0000000000..dff3109770 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummaryCollection.rst @@ -0,0 +1,11 @@ +HostCisBenchmarkScanResultSummaryCollection +=========================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostCisBenchmarkScanResultSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkSettings.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkSettings.rst new file mode 100644 index 0000000000..edf17f53a3 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostCisBenchmarkSettings.rst @@ -0,0 +1,11 @@ +HostCisBenchmarkSettings +======================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostCisBenchmarkSettings + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResult.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResult.rst new file mode 100644 index 0000000000..f552c39156 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResult.rst @@ -0,0 +1,11 @@ +HostEndpointProtectionScanResult +================================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostEndpointProtectionScanResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection.rst new file mode 100644 index 0000000000..a2ac64e40d --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection.rst @@ -0,0 +1,11 @@ +HostEndpointProtectionScanResultEndpointProtection +================================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostEndpointProtectionScanResultEndpointProtection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary.rst new file mode 100644 index 0000000000..9dd753266a --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary.rst @@ -0,0 +1,11 @@ +HostEndpointProtectionScanResultSummary +======================================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostEndpointProtectionScanResultSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummaryCollection.rst new file mode 100644 index 0000000000..417ba69d6b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummaryCollection.rst @@ -0,0 +1,11 @@ +HostEndpointProtectionScanResultSummaryCollection +================================================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostEndpointProtectionScanResultSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionSettings.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionSettings.rst new file mode 100644 index 0000000000..505a22b7de --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostEndpointProtectionSettings.rst @@ -0,0 +1,11 @@ +HostEndpointProtectionSettings +============================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostEndpointProtectionSettings + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResult.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResult.rst new file mode 100644 index 0000000000..7f6c36ba99 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResult.rst @@ -0,0 +1,11 @@ +HostPortScanResult +================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostPortScanResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultOpenPort.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultOpenPort.rst new file mode 100644 index 0000000000..84f3a4cfaa --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultOpenPort.rst @@ -0,0 +1,11 @@ +HostPortScanResultOpenPort +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostPortScanResultOpenPort + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummary.rst new file mode 100644 index 0000000000..1f797d762b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummary.rst @@ -0,0 +1,11 @@ +HostPortScanResultSummary +========================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostPortScanResultSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummaryCollection.rst new file mode 100644 index 0000000000..9d18e7b5e6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostPortScanResultSummaryCollection.rst @@ -0,0 +1,11 @@ +HostPortScanResultSummaryCollection +=================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostPortScanResultSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfiguration.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfiguration.rst new file mode 100644 index 0000000000..6143bd7f7d --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfiguration.rst @@ -0,0 +1,11 @@ +HostScanAgentConfiguration +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanAgentConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfigurationOCI.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfigurationOCI.rst new file mode 100644 index 0000000000..ed739b40f2 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentConfigurationOCI.rst @@ -0,0 +1,11 @@ +HostScanAgentConfigurationOCI +============================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanAgentConfigurationOCI + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentSettings.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentSettings.rst new file mode 100644 index 0000000000..488a508433 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanAgentSettings.rst @@ -0,0 +1,11 @@ +HostScanAgentSettings +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanAgentSettings + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanPortSettings.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanPortSettings.rst new file mode 100644 index 0000000000..0f92c90748 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanPortSettings.rst @@ -0,0 +1,11 @@ +HostScanPortSettings +==================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanPortSettings + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipe.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipe.rst new file mode 100644 index 0000000000..26994b6ba7 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipe.rst @@ -0,0 +1,11 @@ +HostScanRecipe +============== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanRecipe + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummary.rst new file mode 100644 index 0000000000..6f5a47b7bd --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummary.rst @@ -0,0 +1,11 @@ +HostScanRecipeSummary +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanRecipeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummaryCollection.rst new file mode 100644 index 0000000000..acca816e2b --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanRecipeSummaryCollection.rst @@ -0,0 +1,11 @@ +HostScanRecipeSummaryCollection +=============================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanRecipeSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTarget.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTarget.rst new file mode 100644 index 0000000000..c62f8ba4cf --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTarget.rst @@ -0,0 +1,11 @@ +HostScanTarget +============== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanTarget + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummary.rst new file mode 100644 index 0000000000..501635f43e --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummary.rst @@ -0,0 +1,11 @@ +HostScanTargetSummary +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanTargetSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummaryCollection.rst new file mode 100644 index 0000000000..fc052f4c83 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostScanTargetSummaryCollection.rst @@ -0,0 +1,11 @@ +HostScanTargetSummaryCollection +=============================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostScanTargetSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerability.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerability.rst new file mode 100644 index 0000000000..94811eb8f9 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerability.rst @@ -0,0 +1,11 @@ +HostVulnerability +================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostVulnerability + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary.rst new file mode 100644 index 0000000000..e90f18d3a9 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary.rst @@ -0,0 +1,11 @@ +HostVulnerabilityImpactedHostSummary +==================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostVulnerabilityImpactedHostSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummaryCollection.rst new file mode 100644 index 0000000000..1e5907f750 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummaryCollection.rst @@ -0,0 +1,11 @@ +HostVulnerabilityImpactedHostSummaryCollection +============================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostVulnerabilityImpactedHostSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummary.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummary.rst new file mode 100644 index 0000000000..cc4d9a67c3 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummary.rst @@ -0,0 +1,11 @@ +HostVulnerabilitySummary +======================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostVulnerabilitySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummaryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummaryCollection.rst new file mode 100644 index 0000000000..6d06e04bba --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.HostVulnerabilitySummaryCollection.rst @@ -0,0 +1,11 @@ +HostVulnerabilitySummaryCollection +================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: HostVulnerabilitySummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.OcirContainerScanRegistry.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.OcirContainerScanRegistry.rst new file mode 100644 index 0000000000..a700385b06 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.OcirContainerScanRegistry.rst @@ -0,0 +1,11 @@ +OcirContainerScanRegistry +========================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: OcirContainerScanRegistry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.Schedule.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.Schedule.rst new file mode 100644 index 0000000000..f3c2f3fb27 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.Schedule.rst @@ -0,0 +1,11 @@ +Schedule +======== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: Schedule + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails.rst new file mode 100644 index 0000000000..1feadc1d6a --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails.rst @@ -0,0 +1,11 @@ +UpdateContainerScanRecipeDetails +================================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateContainerScanRecipeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails.rst new file mode 100644 index 0000000000..b00b62f998 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails.rst @@ -0,0 +1,11 @@ +UpdateContainerScanRegistryDetails +================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateContainerScanRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails.rst new file mode 100644 index 0000000000..585ddd73ec --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails.rst @@ -0,0 +1,11 @@ +UpdateContainerScanTargetDetails +================================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateContainerScanTargetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails.rst new file mode 100644 index 0000000000..033f65c0b5 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails.rst @@ -0,0 +1,11 @@ +UpdateHostScanRecipeDetails +=========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateHostScanRecipeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanTargetDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanTargetDetails.rst new file mode 100644 index 0000000000..41a5c64a01 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateHostScanTargetDetails.rst @@ -0,0 +1,11 @@ +UpdateHostScanTargetDetails +=========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateHostScanTargetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails.rst new file mode 100644 index 0000000000..d618a32cac --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails.rst @@ -0,0 +1,11 @@ +UpdateOcirContainerScanRegistryDetails +====================================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: UpdateOcirContainerScanRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequest.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequest.rst new file mode 100644 index 0000000000..11f72edc83 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestCollection.rst new file mode 100644 index 0000000000..cae36b0fa7 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestCollection.rst @@ -0,0 +1,11 @@ +WorkRequestCollection +===================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestError.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestError.rst new file mode 100644 index 0000000000..5931c26dba --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestErrorCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..2b1ce982f6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntry.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntry.rst new file mode 100644 index 0000000000..b0b0afbc71 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntry.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntry +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestLogEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntryCollection.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntryCollection.rst new file mode 100644 index 0000000000..a9a22311a6 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestLogEntryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntryCollection +============================= + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestLogEntryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestResource.rst b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestResource.rst new file mode 100644 index 0000000000..2eabeb76e9 --- /dev/null +++ b/docs/api/vulnerability_scanning/models/oci.vulnerability_scanning.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.vulnerability_scanning.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 3971c469ce..20a83cd585 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,9 @@ .. warning:: Potential data corruption with Python SDK on binary upload in versions 2.8.0 and below, for more information please see :ref:`Known Issues` section. +.. important:: + Are you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you. Click `here `_ for the survey page. + Oracle Cloud Infrastructure Python SDK - |OciSdkVersion| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/examples/object_crud.py b/examples/object_crud.py index f8e067a24a..d0b394e83d 100644 --- a/examples/object_crud.py +++ b/examples/object_crud.py @@ -3,9 +3,14 @@ # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. import filecmp +from datetime import datetime, timedelta + +import pytz + import oci +from oci._vendor import urllib3 from oci.object_storage.models import CreateBucketDetails - +from oci.object_storage.models import CreatePreauthenticatedRequestDetails config = oci.config.from_file() compartment_id = config["tenancy"] @@ -15,6 +20,7 @@ bucket_name = "python-sdk-example-bucket" object_name = "python-sdk-example-object" my_data = b"Hello, World!" +par_name = "python-sdk-example-par" print("Creating a new bucket {!r} in compartment {!r}".format( bucket_name, compartment_id)) @@ -60,6 +66,28 @@ print('Uploaded and downloaded files are the same: {}'.format(filecmp.cmp('example_file', 'example_file_retrieved'))) +# Creating a Pre-Authenticated Request +par_ttl = (datetime.utcnow() + timedelta(hours=24)).replace(tzinfo=pytz.UTC) + +create_par_details = CreatePreauthenticatedRequestDetails() +create_par_details.name = par_name +create_par_details.object_name = object_name +create_par_details.access_type = CreatePreauthenticatedRequestDetails.ACCESS_TYPE_OBJECT_READ +create_par_details.time_expires = par_ttl.isoformat() + +par = object_storage.create_preauthenticated_request(namespace_name=namespace, bucket_name=bucket_name, + create_preauthenticated_request_details=create_par_details) + +# Get Object using the Pre-Authenticated Request +par_request_url = object_storage.base_client.get_endpoint() + par.data.access_uri + +http = urllib3.PoolManager() +par_obj = http.request('GET', par_request_url).data.decode('utf-8') +print("Check object from PAR is same or not: {}".format(my_data == bytes(par_obj, 'utf-8'))) + +# Delete Pre-Authenticated Request +object_storage.delete_preauthenticated_request(namespace_name=namespace, bucket_name=bucket_name, par_id=par.data.id) + print("Deleting object {}".format(object_name)) object_storage.delete_object(namespace, bucket_name, object_name) diff --git a/examples/object_storage/object_storage_bulk_restore.py b/examples/object_storage/object_storage_bulk_restore.py index 22a7a5d4e7..de48fdc9f0 100644 --- a/examples/object_storage/object_storage_bulk_restore.py +++ b/examples/object_storage/object_storage_bulk_restore.py @@ -1,28 +1,6 @@ # coding: utf-8 # Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -########################################################################## -# object_storage_bulk_restore.py -# -# @author: Tim S and Adi Z -# -# Supports Python 3 -########################################################################## -# Info: -# Bulk restore with parallel threads -# -########################################################################## -# Application Command line parameters -# -# -c config - Config file section to use (tenancy profile) -# -t profile - Profile in config file, DEFAULT as default -# -p proxy - Set Proxy (i.e. www-proxy-server.com:80) -# -ip - Use Instance Principals for Authentication -# -dt - Use Instance Principals with delegation token for cloud shell -# -sb source_bucket -# -sp source_prefix_include -# -sr source_region -########################################################################## import threading import time diff --git a/src/oci/__init__.py b/src/oci/__init__.py index f6cf2251f1..9f93fa3a8a 100644 --- a/src/oci/__init__.py +++ b/src/oci/__init__.py @@ -2,7 +2,7 @@ # Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -from . import analytics, announcements_service, apigateway, apm_control_plane, apm_synthetics, apm_traces, application_migration, artifacts, audit, autoscaling, bds, blockchain, budget, cims, cloud_guard, compute_instance_agent, container_engine, core, data_catalog, data_flow, data_integration, data_safe, data_science, database, database_management, dns, dts, email, events, file_storage, functions, golden_gate, healthchecks, identity, integration, key_management, limits, load_balancer, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, monitoring, mysql, network_load_balancer, nosql, object_storage, oce, ocvp, oda, ons, opsi, optimizer, os_management, resource_manager, resource_search, rover, sch, secrets, streaming, tenant_manager_control_plane, usage_api, vault, waas, work_requests +from . import analytics, announcements_service, apigateway, apm_control_plane, apm_synthetics, apm_traces, application_migration, artifacts, audit, autoscaling, bds, blockchain, budget, cims, cloud_guard, compute_instance_agent, container_engine, core, data_catalog, data_flow, data_integration, data_safe, data_science, database, database_management, dns, dts, email, events, file_storage, functions, golden_gate, healthchecks, identity, integration, key_management, limits, load_balancer, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, monitoring, mysql, network_load_balancer, nosql, object_storage, oce, ocvp, oda, ons, opsi, optimizer, os_management, resource_manager, resource_search, rover, sch, secrets, streaming, tenant_manager_control_plane, usage_api, vault, vulnerability_scanning, waas, work_requests from . import auth, config, constants, decorators, exceptions, regions, pagination, retry, fips from .base_client import BaseClient from .request import Request @@ -15,5 +15,5 @@ __all__ = [ "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", - "analytics", "announcements_service", "apigateway", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "artifacts", "audit", "autoscaling", "bds", "blockchain", "budget", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "data_catalog", "data_flow", "data_integration", "data_safe", "data_science", "database", "database_management", "dns", "dts", "email", "events", "file_storage", "functions", "golden_gate", "healthchecks", "identity", "integration", "key_management", "limits", "load_balancer", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "monitoring", "mysql", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "ons", "opsi", "optimizer", "os_management", "resource_manager", "resource_search", "rover", "sch", "secrets", "streaming", "tenant_manager_control_plane", "usage_api", "vault", "waas", "work_requests" + "analytics", "announcements_service", "apigateway", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "artifacts", "audit", "autoscaling", "bds", "blockchain", "budget", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "data_catalog", "data_flow", "data_integration", "data_safe", "data_science", "database", "database_management", "dns", "dts", "email", "events", "file_storage", "functions", "golden_gate", "healthchecks", "identity", "integration", "key_management", "limits", "load_balancer", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "monitoring", "mysql", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "ons", "opsi", "optimizer", "os_management", "resource_manager", "resource_search", "rover", "sch", "secrets", "streaming", "tenant_manager_control_plane", "usage_api", "vault", "vulnerability_scanning", "waas", "work_requests" ] diff --git a/src/oci/base_client.py b/src/oci/base_client.py index 7641266ec7..ce71c4ab63 100644 --- a/src/oci/base_client.py +++ b/src/oci/base_client.py @@ -28,7 +28,7 @@ from .request import Request from .response import Response from .version import __version__ -from .util import NONE_SENTINEL, Sentinel +from .util import NONE_SENTINEL, Sentinel, extract_service_endpoint missing = Sentinel("Missing") APPEND_USER_AGENT_ENV_VAR_NAME = "OCI_SDK_APPEND_USER_AGENT" APPEND_USER_AGENT = os.environ.get(APPEND_USER_AGENT_ENV_VAR_NAME) @@ -184,6 +184,9 @@ def endpoint(self, endpoint): else: self._endpoint = endpoint + def get_endpoint(self): + return extract_service_endpoint(self._endpoint) + def set_region(self, region): if self.regional_client: self.endpoint = regions.endpoint_for(self.service, service_endpoint_template=self.service_endpoint_template, region=region) diff --git a/src/oci/database_management/db_management_client.py b/src/oci/database_management/db_management_client.py index 9549df6b5b..49ac9d3e65 100644 --- a/src/oci/database_management/db_management_client.py +++ b/src/oci/database_management/db_management_client.py @@ -180,6 +180,111 @@ def add_managed_database_to_managed_database_group(self, managed_database_group_ header_params=header_params, body=add_managed_database_to_managed_database_group_details) + def change_database_parameters(self, managed_database_id, change_database_parameters_details, **kwargs): + """ + Changes database parameters' values. There are two kinds of database + parameters: + + - Dynamic parameters: They can be changed for the current Oracle + Database instance. The changes take effect immediately. + - Static parameters: They cannot be changed for the current instance. + You must change these parameters and then restart the database before + changes take effect. + + **Note:** If the instance is started using a text initialization + parameter file, the parameter changes are applicable only for the + current instance. You must update them manually to be passed to + a future instance. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.ChangeDatabaseParametersDetails change_database_parameters_details: (required) + The details required to change database parameters' values. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 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.database_management.models.UpdateDatabaseParametersResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_database_parameters API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/actions/changeDatabaseParameters" + 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( + "change_database_parameters got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_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=change_database_parameters_details, + response_type="UpdateDatabaseParametersResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_database_parameters_details, + response_type="UpdateDatabaseParametersResult") + def change_job_compartment(self, job_id, change_job_compartment_details, **kwargs): """ Moves a job. @@ -1285,6 +1390,145 @@ def get_managed_database_group(self, managed_database_group_id, **kwargs): header_params=header_params, response_type="ManagedDatabaseGroup") + def list_database_parameters(self, managed_database_id, **kwargs): + """ + Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str source: (optional) + The source used to list database parameters. `CURRENT` is used to get the + database parameters that are currently in effect for the database + instance. `SPFILE` is used to list parameters from the server parameter + file. Default is `CURRENT`. + + Allowed values are: "CURRENT", "SPFILE" + + :param str name: (optional) + A filter to return all parameters that have the text given in their names. + + :param bool is_allowed_values_included: (optional) + When true, results include a list of valid values for parameters (if applicable). + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The + default sort order for `NAME` is ascending and it is case-sensitive. + + Allowed values are: "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. + + 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 :class:`~oci.database_management.models.DatabaseParametersCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_database_parameters API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/databaseParameters" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "source", + "name", + "is_allowed_values_included", + "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_database_parameters got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_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)) + + if 'source' in kwargs: + source_allowed_values = ["CURRENT", "SPFILE"] + if kwargs['source'] not in source_allowed_values: + raise ValueError( + "Invalid value for `source`, must be one of {0}".format(source_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + 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 = { + "source": kwargs.get("source", missing), + "name": kwargs.get("name", missing), + "isAllowedValuesIncluded": kwargs.get("is_allowed_values_included", 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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="DatabaseParametersCollection") + 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="DatabaseParametersCollection") + def list_job_executions(self, compartment_id, **kwargs): """ Gets the job execution for a specific ID or the list of job executions for a job, Managed Database or Managed Database Group @@ -2004,6 +2248,135 @@ def list_managed_databases(self, compartment_id, **kwargs): header_params=header_params, response_type="ManagedDatabaseCollection") + def list_tablespaces(self, managed_database_id, **kwargs): + """ + Gets the list of tablespaces for the specified managedDatabaseId. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. + The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "TIMECREATED", "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + The page token representing the page, from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in paginated response. + + :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.database_management.models.TablespaceCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_tablespaces API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/tablespaces" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "name", + "sort_by", + "sort_order", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_tablespaces got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_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)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "NAME"] + 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 = { + "name": kwargs.get("name", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", 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="TablespaceCollection") + 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="TablespaceCollection") + def remove_managed_database_from_managed_database_group(self, managed_database_group_id, remove_managed_database_from_managed_database_group_details, **kwargs): """ Removes a Managed Database from a Managed Database Group. Any management @@ -2098,6 +2471,99 @@ def remove_managed_database_from_managed_database_group(self, managed_database_g header_params=header_params, body=remove_managed_database_from_managed_database_group_details) + def reset_database_parameters(self, managed_database_id, reset_database_parameters_details, **kwargs): + """ + Resets database parameters' values to their default or startup values. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.ResetDatabaseParametersDetails reset_database_parameters_details: (required) + The details required to reset database parameters. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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 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.database_management.models.UpdateDatabaseParametersResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use reset_database_parameters API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/actions/resetDatabaseParameters" + 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( + "reset_database_parameters got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_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=reset_database_parameters_details, + response_type="UpdateDatabaseParametersResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=reset_database_parameters_details, + response_type="UpdateDatabaseParametersResult") + def update_managed_database_group(self, managed_database_group_id, update_managed_database_group_details, **kwargs): """ Updates the Managed Database Group specified by managedDatabaseGroupId. diff --git a/src/oci/database_management/models/__init__.py b/src/oci/database_management/models/__init__.py index 8c7840783e..60cbee2e89 100644 --- a/src/oci/database_management/models/__init__.py +++ b/src/oci/database_management/models/__init__.py @@ -6,19 +6,27 @@ from .activity_time_series_metrics import ActivityTimeSeriesMetrics from .add_managed_database_to_managed_database_group_details import AddManagedDatabaseToManagedDatabaseGroupDetails +from .allowed_parameter_value import AllowedParameterValue +from .change_database_parameter_details import ChangeDatabaseParameterDetails +from .change_database_parameters_details import ChangeDatabaseParametersDetails from .change_job_compartment_details import ChangeJobCompartmentDetails from .change_managed_database_group_compartment_details import ChangeManagedDatabaseGroupCompartmentDetails from .child_database import ChildDatabase from .create_job_details import CreateJobDetails from .create_managed_database_group_details import CreateManagedDatabaseGroupDetails from .create_sql_job_details import CreateSqlJobDetails +from .database_credentials import DatabaseCredentials from .database_fleet_health_metrics import DatabaseFleetHealthMetrics from .database_home_metric_definition import DatabaseHomeMetricDefinition from .database_home_metrics import DatabaseHomeMetrics from .database_io_aggregate_metrics import DatabaseIOAggregateMetrics +from .database_parameter_summary import DatabaseParameterSummary +from .database_parameter_update_status import DatabaseParameterUpdateStatus +from .database_parameters_collection import DatabaseParametersCollection from .database_storage_aggregate_metrics import DatabaseStorageAggregateMetrics from .database_time_aggregate_metrics import DatabaseTimeAggregateMetrics from .database_usage_metrics import DatabaseUsageMetrics +from .datafile import Datafile from .fleet_metric_definition import FleetMetricDefinition from .fleet_metric_summary_definition import FleetMetricSummaryDefinition from .fleet_status_by_category import FleetStatusByCategory @@ -48,26 +56,39 @@ from .object_storage_job_execution_result_location import ObjectStorageJobExecutionResultLocation from .parent_group import ParentGroup from .remove_managed_database_from_managed_database_group_details import RemoveManagedDatabaseFromManagedDatabaseGroupDetails +from .reset_database_parameters_details import ResetDatabaseParametersDetails from .sql_job import SqlJob +from .tablespace import Tablespace +from .tablespace_collection import TablespaceCollection +from .tablespace_summary import TablespaceSummary +from .update_database_parameters_result import UpdateDatabaseParametersResult from .update_managed_database_group_details import UpdateManagedDatabaseGroupDetails # Maps type names to classes for database_management services. database_management_type_mapping = { "ActivityTimeSeriesMetrics": ActivityTimeSeriesMetrics, "AddManagedDatabaseToManagedDatabaseGroupDetails": AddManagedDatabaseToManagedDatabaseGroupDetails, + "AllowedParameterValue": AllowedParameterValue, + "ChangeDatabaseParameterDetails": ChangeDatabaseParameterDetails, + "ChangeDatabaseParametersDetails": ChangeDatabaseParametersDetails, "ChangeJobCompartmentDetails": ChangeJobCompartmentDetails, "ChangeManagedDatabaseGroupCompartmentDetails": ChangeManagedDatabaseGroupCompartmentDetails, "ChildDatabase": ChildDatabase, "CreateJobDetails": CreateJobDetails, "CreateManagedDatabaseGroupDetails": CreateManagedDatabaseGroupDetails, "CreateSqlJobDetails": CreateSqlJobDetails, + "DatabaseCredentials": DatabaseCredentials, "DatabaseFleetHealthMetrics": DatabaseFleetHealthMetrics, "DatabaseHomeMetricDefinition": DatabaseHomeMetricDefinition, "DatabaseHomeMetrics": DatabaseHomeMetrics, "DatabaseIOAggregateMetrics": DatabaseIOAggregateMetrics, + "DatabaseParameterSummary": DatabaseParameterSummary, + "DatabaseParameterUpdateStatus": DatabaseParameterUpdateStatus, + "DatabaseParametersCollection": DatabaseParametersCollection, "DatabaseStorageAggregateMetrics": DatabaseStorageAggregateMetrics, "DatabaseTimeAggregateMetrics": DatabaseTimeAggregateMetrics, "DatabaseUsageMetrics": DatabaseUsageMetrics, + "Datafile": Datafile, "FleetMetricDefinition": FleetMetricDefinition, "FleetMetricSummaryDefinition": FleetMetricSummaryDefinition, "FleetStatusByCategory": FleetStatusByCategory, @@ -97,6 +118,11 @@ "ObjectStorageJobExecutionResultLocation": ObjectStorageJobExecutionResultLocation, "ParentGroup": ParentGroup, "RemoveManagedDatabaseFromManagedDatabaseGroupDetails": RemoveManagedDatabaseFromManagedDatabaseGroupDetails, + "ResetDatabaseParametersDetails": ResetDatabaseParametersDetails, "SqlJob": SqlJob, + "Tablespace": Tablespace, + "TablespaceCollection": TablespaceCollection, + "TablespaceSummary": TablespaceSummary, + "UpdateDatabaseParametersResult": UpdateDatabaseParametersResult, "UpdateManagedDatabaseGroupDetails": UpdateManagedDatabaseGroupDetails } diff --git a/src/oci/database_management/models/allowed_parameter_value.py b/src/oci/database_management/models/allowed_parameter_value.py new file mode 100644 index 0000000000..8ea1a21457 --- /dev/null +++ b/src/oci/database_management/models/allowed_parameter_value.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AllowedParameterValue(object): + """ + A valid value for a database parameter. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AllowedParameterValue object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param ordinal: + The value to assign to the ordinal property of this AllowedParameterValue. + :type ordinal: float + + :param value: + The value to assign to the value property of this AllowedParameterValue. + :type value: str + + :param is_default: + The value to assign to the is_default property of this AllowedParameterValue. + :type is_default: bool + + """ + self.swagger_types = { + 'ordinal': 'float', + 'value': 'str', + 'is_default': 'bool' + } + + self.attribute_map = { + 'ordinal': 'ordinal', + 'value': 'value', + 'is_default': 'isDefault' + } + + self._ordinal = None + self._value = None + self._is_default = None + + @property + def ordinal(self): + """ + Gets the ordinal of this AllowedParameterValue. + The ordinal number in the list (1-based). + + + :return: The ordinal of this AllowedParameterValue. + :rtype: float + """ + return self._ordinal + + @ordinal.setter + def ordinal(self, ordinal): + """ + Sets the ordinal of this AllowedParameterValue. + The ordinal number in the list (1-based). + + + :param ordinal: The ordinal of this AllowedParameterValue. + :type: float + """ + self._ordinal = ordinal + + @property + def value(self): + """ + Gets the value of this AllowedParameterValue. + The parameter value at ordinal. + + + :return: The value of this AllowedParameterValue. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this AllowedParameterValue. + The parameter value at ordinal. + + + :param value: The value of this AllowedParameterValue. + :type: str + """ + self._value = value + + @property + def is_default(self): + """ + Gets the is_default of this AllowedParameterValue. + Indicates whether the given ordinal value is the default value for the parameter. + + + :return: The is_default of this AllowedParameterValue. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this AllowedParameterValue. + Indicates whether the given ordinal value is the default value for the parameter. + + + :param is_default: The is_default of this AllowedParameterValue. + :type: bool + """ + self._is_default = is_default + + 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/database_management/models/change_database_parameter_details.py b/src/oci/database_management/models/change_database_parameter_details.py new file mode 100644 index 0000000000..26f85ae804 --- /dev/null +++ b/src/oci/database_management/models/change_database_parameter_details.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeDatabaseParameterDetails(object): + """ + The value of a database parameter to change. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeDatabaseParameterDetails 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 ChangeDatabaseParameterDetails. + :type name: str + + :param value: + The value to assign to the value property of this ChangeDatabaseParameterDetails. + :type value: str + + :param update_comment: + The value to assign to the update_comment property of this ChangeDatabaseParameterDetails. + :type update_comment: str + + """ + self.swagger_types = { + 'name': 'str', + 'value': 'str', + 'update_comment': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'value': 'value', + 'update_comment': 'updateComment' + } + + self._name = None + self._value = None + self._update_comment = None + + @property + def name(self): + """ + **[Required]** Gets the name of this ChangeDatabaseParameterDetails. + The parameter name. + + + :return: The name of this ChangeDatabaseParameterDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ChangeDatabaseParameterDetails. + The parameter name. + + + :param name: The name of this ChangeDatabaseParameterDetails. + :type: str + """ + self._name = name + + @property + def value(self): + """ + **[Required]** Gets the value of this ChangeDatabaseParameterDetails. + The parameter value. + + + :return: The value of this ChangeDatabaseParameterDetails. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ChangeDatabaseParameterDetails. + The parameter value. + + + :param value: The value of this ChangeDatabaseParameterDetails. + :type: str + """ + self._value = value + + @property + def update_comment(self): + """ + Gets the update_comment of this ChangeDatabaseParameterDetails. + A comment string to associate with the change in parameter value. + It cannot contain control characters or a line break. + + + :return: The update_comment of this ChangeDatabaseParameterDetails. + :rtype: str + """ + return self._update_comment + + @update_comment.setter + def update_comment(self, update_comment): + """ + Sets the update_comment of this ChangeDatabaseParameterDetails. + A comment string to associate with the change in parameter value. + It cannot contain control characters or a line break. + + + :param update_comment: The update_comment of this ChangeDatabaseParameterDetails. + :type: str + """ + self._update_comment = update_comment + + 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/database_management/models/change_database_parameters_details.py b/src/oci/database_management/models/change_database_parameters_details.py new file mode 100644 index 0000000000..55bd7132eb --- /dev/null +++ b/src/oci/database_management/models/change_database_parameters_details.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeDatabaseParametersDetails(object): + """ + The details required to change database parameters' values. + """ + + #: A constant which can be used with the scope property of a ChangeDatabaseParametersDetails. + #: This constant has a value of "MEMORY" + SCOPE_MEMORY = "MEMORY" + + #: A constant which can be used with the scope property of a ChangeDatabaseParametersDetails. + #: This constant has a value of "SPFILE" + SCOPE_SPFILE = "SPFILE" + + #: A constant which can be used with the scope property of a ChangeDatabaseParametersDetails. + #: This constant has a value of "BOTH" + SCOPE_BOTH = "BOTH" + + def __init__(self, **kwargs): + """ + Initializes a new ChangeDatabaseParametersDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credentials: + The value to assign to the credentials property of this ChangeDatabaseParametersDetails. + :type credentials: oci.database_management.models.DatabaseCredentials + + :param scope: + The value to assign to the scope property of this ChangeDatabaseParametersDetails. + Allowed values for this property are: "MEMORY", "SPFILE", "BOTH" + :type scope: str + + :param parameters: + The value to assign to the parameters property of this ChangeDatabaseParametersDetails. + :type parameters: list[oci.database_management.models.ChangeDatabaseParameterDetails] + + """ + self.swagger_types = { + 'credentials': 'DatabaseCredentials', + 'scope': 'str', + 'parameters': 'list[ChangeDatabaseParameterDetails]' + } + + self.attribute_map = { + 'credentials': 'credentials', + 'scope': 'scope', + 'parameters': 'parameters' + } + + self._credentials = None + self._scope = None + self._parameters = None + + @property + def credentials(self): + """ + **[Required]** Gets the credentials of this ChangeDatabaseParametersDetails. + + :return: The credentials of this ChangeDatabaseParametersDetails. + :rtype: oci.database_management.models.DatabaseCredentials + """ + return self._credentials + + @credentials.setter + def credentials(self, credentials): + """ + Sets the credentials of this ChangeDatabaseParametersDetails. + + :param credentials: The credentials of this ChangeDatabaseParametersDetails. + :type: oci.database_management.models.DatabaseCredentials + """ + self._credentials = credentials + + @property + def scope(self): + """ + **[Required]** Gets the scope of this ChangeDatabaseParametersDetails. + The clause used to specify when the parameter change takes effect. + + Use `MEMORY` to make the change in memory and affect it immediately. + Use `SPFILE` to make the change in the server parameter file. The + change takes effect when the database is next shut down and started + up again. Use `BOTH` to make the change in memory and in the server + parameter file. The change takes effect immediately and persists + after the database is shut down and started up again. + + Allowed values for this property are: "MEMORY", "SPFILE", "BOTH" + + + :return: The scope of this ChangeDatabaseParametersDetails. + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """ + Sets the scope of this ChangeDatabaseParametersDetails. + The clause used to specify when the parameter change takes effect. + + Use `MEMORY` to make the change in memory and affect it immediately. + Use `SPFILE` to make the change in the server parameter file. The + change takes effect when the database is next shut down and started + up again. Use `BOTH` to make the change in memory and in the server + parameter file. The change takes effect immediately and persists + after the database is shut down and started up again. + + + :param scope: The scope of this ChangeDatabaseParametersDetails. + :type: str + """ + allowed_values = ["MEMORY", "SPFILE", "BOTH"] + if not value_allowed_none_or_none_sentinel(scope, allowed_values): + raise ValueError( + "Invalid value for `scope`, must be None or one of {0}" + .format(allowed_values) + ) + self._scope = scope + + @property + def parameters(self): + """ + **[Required]** Gets the parameters of this ChangeDatabaseParametersDetails. + A list of database parameters and their values. + + + :return: The parameters of this ChangeDatabaseParametersDetails. + :rtype: list[oci.database_management.models.ChangeDatabaseParameterDetails] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this ChangeDatabaseParametersDetails. + A list of database parameters and their values. + + + :param parameters: The parameters of this ChangeDatabaseParametersDetails. + :type: list[oci.database_management.models.ChangeDatabaseParameterDetails] + """ + self._parameters = parameters + + 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/database_management/models/database_credentials.py b/src/oci/database_management/models/database_credentials.py new file mode 100644 index 0000000000..2961a14950 --- /dev/null +++ b/src/oci/database_management/models/database_credentials.py @@ -0,0 +1,149 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DatabaseCredentials(object): + """ + The database credentials used to perform management activity. + """ + + #: A constant which can be used with the role property of a DatabaseCredentials. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a DatabaseCredentials. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new DatabaseCredentials object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param user_name: + The value to assign to the user_name property of this DatabaseCredentials. + :type user_name: str + + :param password: + The value to assign to the password property of this DatabaseCredentials. + :type password: str + + :param role: + The value to assign to the role property of this DatabaseCredentials. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + """ + self.swagger_types = { + 'user_name': 'str', + 'password': 'str', + 'role': 'str' + } + + self.attribute_map = { + 'user_name': 'userName', + 'password': 'password', + 'role': 'role' + } + + self._user_name = None + self._password = None + self._role = None + + @property + def user_name(self): + """ + Gets the user_name of this DatabaseCredentials. + The database user name used to perform management activity. + + + :return: The user_name of this DatabaseCredentials. + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """ + Sets the user_name of this DatabaseCredentials. + The database user name used to perform management activity. + + + :param user_name: The user_name of this DatabaseCredentials. + :type: str + """ + self._user_name = user_name + + @property + def password(self): + """ + Gets the password of this DatabaseCredentials. + The password for the database user name. + + + :return: The password of this DatabaseCredentials. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this DatabaseCredentials. + The password for the database user name. + + + :param password: The password of this DatabaseCredentials. + :type: str + """ + self._password = password + + @property + def role(self): + """ + Gets the role of this DatabaseCredentials. + The role of the database user. Indicates whether the database user is a normal user or sysdba. + + Allowed values for this property are: "NORMAL", "SYSDBA" + + + :return: The role of this DatabaseCredentials. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this DatabaseCredentials. + The role of the database user. Indicates whether the database user is a normal user or sysdba. + + + :param role: The role of this DatabaseCredentials. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + raise ValueError( + "Invalid value for `role`, must be None or one of {0}" + .format(allowed_values) + ) + self._role = role + + 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/database_management/models/database_parameter_summary.py b/src/oci/database_management/models/database_parameter_summary.py new file mode 100644 index 0000000000..a0ace1919d --- /dev/null +++ b/src/oci/database_management/models/database_parameter_summary.py @@ -0,0 +1,864 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DatabaseParameterSummary(object): + """ + The details of a database parameter. + """ + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "BOOLEAN" + TYPE_BOOLEAN = "BOOLEAN" + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "STRING" + TYPE_STRING = "STRING" + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "INTEGER" + TYPE_INTEGER = "INTEGER" + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "FILENAME" + TYPE_FILENAME = "FILENAME" + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "BIG_INTEGER" + TYPE_BIG_INTEGER = "BIG_INTEGER" + + #: A constant which can be used with the type property of a DatabaseParameterSummary. + #: This constant has a value of "RESERVED" + TYPE_RESERVED = "RESERVED" + + #: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. + #: This constant has a value of "IMMEDIATE" + IS_SYSTEM_MODIFIABLE_IMMEDIATE = "IMMEDIATE" + + #: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. + #: This constant has a value of "DEFERRED" + IS_SYSTEM_MODIFIABLE_DEFERRED = "DEFERRED" + + #: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. + #: This constant has a value of "FALSE" + IS_SYSTEM_MODIFIABLE_FALSE = "FALSE" + + #: A constant which can be used with the is_modified property of a DatabaseParameterSummary. + #: This constant has a value of "MODIFIED" + IS_MODIFIED_MODIFIED = "MODIFIED" + + #: A constant which can be used with the is_modified property of a DatabaseParameterSummary. + #: This constant has a value of "FALSE" + IS_MODIFIED_FALSE = "FALSE" + + #: A constant which can be used with the constraint property of a DatabaseParameterSummary. + #: This constant has a value of "UNIQUE" + CONSTRAINT_UNIQUE = "UNIQUE" + + #: A constant which can be used with the constraint property of a DatabaseParameterSummary. + #: This constant has a value of "IDENTICAL" + CONSTRAINT_IDENTICAL = "IDENTICAL" + + #: A constant which can be used with the constraint property of a DatabaseParameterSummary. + #: This constant has a value of "NONE" + CONSTRAINT_NONE = "NONE" + + def __init__(self, **kwargs): + """ + Initializes a new DatabaseParameterSummary 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 DatabaseParameterSummary. + :type name: str + + :param type: + The value to assign to the type property of this DatabaseParameterSummary. + Allowed values for this property are: "BOOLEAN", "STRING", "INTEGER", "FILENAME", "BIG_INTEGER", "RESERVED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param value: + The value to assign to the value property of this DatabaseParameterSummary. + :type value: str + + :param display_value: + The value to assign to the display_value property of this DatabaseParameterSummary. + :type display_value: str + + :param number: + The value to assign to the number property of this DatabaseParameterSummary. + :type number: float + + :param is_default: + The value to assign to the is_default property of this DatabaseParameterSummary. + :type is_default: bool + + :param is_session_modifiable: + The value to assign to the is_session_modifiable property of this DatabaseParameterSummary. + :type is_session_modifiable: bool + + :param is_system_modifiable: + The value to assign to the is_system_modifiable property of this DatabaseParameterSummary. + Allowed values for this property are: "IMMEDIATE", "DEFERRED", "FALSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type is_system_modifiable: str + + :param is_pdb_modifiable: + The value to assign to the is_pdb_modifiable property of this DatabaseParameterSummary. + :type is_pdb_modifiable: bool + + :param is_instance_modifiable: + The value to assign to the is_instance_modifiable property of this DatabaseParameterSummary. + :type is_instance_modifiable: bool + + :param is_modified: + The value to assign to the is_modified property of this DatabaseParameterSummary. + Allowed values for this property are: "MODIFIED", "FALSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type is_modified: str + + :param is_adjusted: + The value to assign to the is_adjusted property of this DatabaseParameterSummary. + :type is_adjusted: bool + + :param is_deprecated: + The value to assign to the is_deprecated property of this DatabaseParameterSummary. + :type is_deprecated: bool + + :param is_basic: + The value to assign to the is_basic property of this DatabaseParameterSummary. + :type is_basic: bool + + :param description: + The value to assign to the description property of this DatabaseParameterSummary. + :type description: str + + :param ordinal: + The value to assign to the ordinal property of this DatabaseParameterSummary. + :type ordinal: float + + :param update_comment: + The value to assign to the update_comment property of this DatabaseParameterSummary. + :type update_comment: str + + :param container_id: + The value to assign to the container_id property of this DatabaseParameterSummary. + :type container_id: float + + :param category: + The value to assign to the category property of this DatabaseParameterSummary. + :type category: str + + :param constraint: + The value to assign to the constraint property of this DatabaseParameterSummary. + Allowed values for this property are: "UNIQUE", "IDENTICAL", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type constraint: str + + :param sid: + The value to assign to the sid property of this DatabaseParameterSummary. + :type sid: str + + :param is_specified: + The value to assign to the is_specified property of this DatabaseParameterSummary. + :type is_specified: bool + + :param allowed_values: + The value to assign to the allowed_values property of this DatabaseParameterSummary. + :type allowed_values: list[oci.database_management.models.AllowedParameterValue] + + """ + self.swagger_types = { + 'name': 'str', + 'type': 'str', + 'value': 'str', + 'display_value': 'str', + 'number': 'float', + 'is_default': 'bool', + 'is_session_modifiable': 'bool', + 'is_system_modifiable': 'str', + 'is_pdb_modifiable': 'bool', + 'is_instance_modifiable': 'bool', + 'is_modified': 'str', + 'is_adjusted': 'bool', + 'is_deprecated': 'bool', + 'is_basic': 'bool', + 'description': 'str', + 'ordinal': 'float', + 'update_comment': 'str', + 'container_id': 'float', + 'category': 'str', + 'constraint': 'str', + 'sid': 'str', + 'is_specified': 'bool', + 'allowed_values': 'list[AllowedParameterValue]' + } + + self.attribute_map = { + 'name': 'name', + 'type': 'type', + 'value': 'value', + 'display_value': 'displayValue', + 'number': 'number', + 'is_default': 'isDefault', + 'is_session_modifiable': 'isSessionModifiable', + 'is_system_modifiable': 'isSystemModifiable', + 'is_pdb_modifiable': 'isPdbModifiable', + 'is_instance_modifiable': 'isInstanceModifiable', + 'is_modified': 'isModified', + 'is_adjusted': 'isAdjusted', + 'is_deprecated': 'isDeprecated', + 'is_basic': 'isBasic', + 'description': 'description', + 'ordinal': 'ordinal', + 'update_comment': 'updateComment', + 'container_id': 'containerId', + 'category': 'category', + 'constraint': 'constraint', + 'sid': 'sid', + 'is_specified': 'isSpecified', + 'allowed_values': 'allowedValues' + } + + self._name = None + self._type = None + self._value = None + self._display_value = None + self._number = None + self._is_default = None + self._is_session_modifiable = None + self._is_system_modifiable = None + self._is_pdb_modifiable = None + self._is_instance_modifiable = None + self._is_modified = None + self._is_adjusted = None + self._is_deprecated = None + self._is_basic = None + self._description = None + self._ordinal = None + self._update_comment = None + self._container_id = None + self._category = None + self._constraint = None + self._sid = None + self._is_specified = None + self._allowed_values = None + + @property + def name(self): + """ + **[Required]** Gets the name of this DatabaseParameterSummary. + The parameter name. + + + :return: The name of this DatabaseParameterSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DatabaseParameterSummary. + The parameter name. + + + :param name: The name of this DatabaseParameterSummary. + :type: str + """ + self._name = name + + @property + def type(self): + """ + **[Required]** Gets the type of this DatabaseParameterSummary. + The parameter type. + + Allowed values for this property are: "BOOLEAN", "STRING", "INTEGER", "FILENAME", "BIG_INTEGER", "RESERVED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this DatabaseParameterSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this DatabaseParameterSummary. + The parameter type. + + + :param type: The type of this DatabaseParameterSummary. + :type: str + """ + allowed_values = ["BOOLEAN", "STRING", "INTEGER", "FILENAME", "BIG_INTEGER", "RESERVED"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def value(self): + """ + **[Required]** Gets the value of this DatabaseParameterSummary. + The parameter value. + + + :return: The value of this DatabaseParameterSummary. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this DatabaseParameterSummary. + The parameter value. + + + :param value: The value of this DatabaseParameterSummary. + :type: str + """ + self._value = value + + @property + def display_value(self): + """ + **[Required]** Gets the display_value of this DatabaseParameterSummary. + The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K. + + + :return: The display_value of this DatabaseParameterSummary. + :rtype: str + """ + return self._display_value + + @display_value.setter + def display_value(self, display_value): + """ + Sets the display_value of this DatabaseParameterSummary. + The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K. + + + :param display_value: The display_value of this DatabaseParameterSummary. + :type: str + """ + self._display_value = display_value + + @property + def number(self): + """ + Gets the number of this DatabaseParameterSummary. + The parameter number. + + + :return: The number of this DatabaseParameterSummary. + :rtype: float + """ + return self._number + + @number.setter + def number(self, number): + """ + Sets the number of this DatabaseParameterSummary. + The parameter number. + + + :param number: The number of this DatabaseParameterSummary. + :type: float + """ + self._number = number + + @property + def is_default(self): + """ + Gets the is_default of this DatabaseParameterSummary. + Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). + + + :return: The is_default of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this DatabaseParameterSummary. + Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). + + + :param is_default: The is_default of this DatabaseParameterSummary. + :type: bool + """ + self._is_default = is_default + + @property + def is_session_modifiable(self): + """ + Gets the is_session_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`) + + + :return: The is_session_modifiable of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_session_modifiable + + @is_session_modifiable.setter + def is_session_modifiable(self, is_session_modifiable): + """ + Sets the is_session_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`) + + + :param is_session_modifiable: The is_session_modifiable of this DatabaseParameterSummary. + :type: bool + """ + self._is_session_modifiable = is_session_modifiable + + @property + def is_system_modifiable(self): + """ + Gets the is_system_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect: + - IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately. + - DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. + - FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances. + + Allowed values for this property are: "IMMEDIATE", "DEFERRED", "FALSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The is_system_modifiable of this DatabaseParameterSummary. + :rtype: str + """ + return self._is_system_modifiable + + @is_system_modifiable.setter + def is_system_modifiable(self, is_system_modifiable): + """ + Sets the is_system_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect: + - IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately. + - DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. + - FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances. + + + :param is_system_modifiable: The is_system_modifiable of this DatabaseParameterSummary. + :type: str + """ + allowed_values = ["IMMEDIATE", "DEFERRED", "FALSE"] + if not value_allowed_none_or_none_sentinel(is_system_modifiable, allowed_values): + is_system_modifiable = 'UNKNOWN_ENUM_VALUE' + self._is_system_modifiable = is_system_modifiable + + @property + def is_pdb_modifiable(self): + """ + Gets the is_pdb_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`. + + + :return: The is_pdb_modifiable of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_pdb_modifiable + + @is_pdb_modifiable.setter + def is_pdb_modifiable(self, is_pdb_modifiable): + """ + Sets the is_pdb_modifiable of this DatabaseParameterSummary. + Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`. + + + :param is_pdb_modifiable: The is_pdb_modifiable of this DatabaseParameterSummary. + :type: bool + """ + self._is_pdb_modifiable = is_pdb_modifiable + + @property + def is_instance_modifiable(self): + """ + Gets the is_instance_modifiable of this DatabaseParameterSummary. + For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`. + + + :return: The is_instance_modifiable of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_instance_modifiable + + @is_instance_modifiable.setter + def is_instance_modifiable(self, is_instance_modifiable): + """ + Sets the is_instance_modifiable of this DatabaseParameterSummary. + For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`. + + + :param is_instance_modifiable: The is_instance_modifiable of this DatabaseParameterSummary. + :type: bool + """ + self._is_instance_modifiable = is_instance_modifiable + + @property + def is_modified(self): + """ + Gets the is_modified of this DatabaseParameterSummary. + Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`. + + Allowed values for this property are: "MODIFIED", "FALSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The is_modified of this DatabaseParameterSummary. + :rtype: str + """ + return self._is_modified + + @is_modified.setter + def is_modified(self, is_modified): + """ + Sets the is_modified of this DatabaseParameterSummary. + Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`. + + + :param is_modified: The is_modified of this DatabaseParameterSummary. + :type: str + """ + allowed_values = ["MODIFIED", "FALSE"] + if not value_allowed_none_or_none_sentinel(is_modified, allowed_values): + is_modified = 'UNKNOWN_ENUM_VALUE' + self._is_modified = is_modified + + @property + def is_adjusted(self): + """ + Gets the is_adjusted of this DatabaseParameterSummary. + Indicates whether Oracle adjusted the input value to a more suitable value. + + + :return: The is_adjusted of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_adjusted + + @is_adjusted.setter + def is_adjusted(self, is_adjusted): + """ + Sets the is_adjusted of this DatabaseParameterSummary. + Indicates whether Oracle adjusted the input value to a more suitable value. + + + :param is_adjusted: The is_adjusted of this DatabaseParameterSummary. + :type: bool + """ + self._is_adjusted = is_adjusted + + @property + def is_deprecated(self): + """ + Gets the is_deprecated of this DatabaseParameterSummary. + Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`). + + + :return: The is_deprecated of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_deprecated + + @is_deprecated.setter + def is_deprecated(self, is_deprecated): + """ + Sets the is_deprecated of this DatabaseParameterSummary. + Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`). + + + :param is_deprecated: The is_deprecated of this DatabaseParameterSummary. + :type: bool + """ + self._is_deprecated = is_deprecated + + @property + def is_basic(self): + """ + Gets the is_basic of this DatabaseParameterSummary. + Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`). + + + :return: The is_basic of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_basic + + @is_basic.setter + def is_basic(self, is_basic): + """ + Sets the is_basic of this DatabaseParameterSummary. + Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`). + + + :param is_basic: The is_basic of this DatabaseParameterSummary. + :type: bool + """ + self._is_basic = is_basic + + @property + def description(self): + """ + Gets the description of this DatabaseParameterSummary. + The description of the parameter. + + + :return: The description of this DatabaseParameterSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DatabaseParameterSummary. + The description of the parameter. + + + :param description: The description of this DatabaseParameterSummary. + :type: str + """ + self._description = description + + @property + def ordinal(self): + """ + Gets the ordinal of this DatabaseParameterSummary. + The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. + + + :return: The ordinal of this DatabaseParameterSummary. + :rtype: float + """ + return self._ordinal + + @ordinal.setter + def ordinal(self, ordinal): + """ + Sets the ordinal of this DatabaseParameterSummary. + The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. + + + :param ordinal: The ordinal of this DatabaseParameterSummary. + :type: float + """ + self._ordinal = ordinal + + @property + def update_comment(self): + """ + Gets the update_comment of this DatabaseParameterSummary. + The comments associated with the most recent update. + + + :return: The update_comment of this DatabaseParameterSummary. + :rtype: str + """ + return self._update_comment + + @update_comment.setter + def update_comment(self, update_comment): + """ + Sets the update_comment of this DatabaseParameterSummary. + The comments associated with the most recent update. + + + :param update_comment: The update_comment of this DatabaseParameterSummary. + :type: str + """ + self._update_comment = update_comment + + @property + def container_id(self): + """ + Gets the container_id of this DatabaseParameterSummary. + The ID of the database container to which the data pertains. + Possible values include: + - `0`: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs. + - `1`: This value is used for data that pertain to only the root container. + - `n`: Where n is the applicable container ID for the data. + + + :return: The container_id of this DatabaseParameterSummary. + :rtype: float + """ + return self._container_id + + @container_id.setter + def container_id(self, container_id): + """ + Sets the container_id of this DatabaseParameterSummary. + The ID of the database container to which the data pertains. + Possible values include: + - `0`: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs. + - `1`: This value is used for data that pertain to only the root container. + - `n`: Where n is the applicable container ID for the data. + + + :param container_id: The container_id of this DatabaseParameterSummary. + :type: float + """ + self._container_id = container_id + + @property + def category(self): + """ + Gets the category of this DatabaseParameterSummary. + The parameter category. + + + :return: The category of this DatabaseParameterSummary. + :rtype: str + """ + return self._category + + @category.setter + def category(self, category): + """ + Sets the category of this DatabaseParameterSummary. + The parameter category. + + + :param category: The category of this DatabaseParameterSummary. + :type: str + """ + self._category = category + + @property + def constraint(self): + """ + Gets the constraint of this DatabaseParameterSummary. + Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. + A `UNIQUE` parameter is one which is unique to each Oracle Real Application + Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER` + must have different values in each instance. An `IDENTICAL` parameter must + have the same value for every instance. For example, the parameter + `DB_BLOCK_SIZE` must have the same value in all instances. + + Allowed values for this property are: "UNIQUE", "IDENTICAL", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The constraint of this DatabaseParameterSummary. + :rtype: str + """ + return self._constraint + + @constraint.setter + def constraint(self, constraint): + """ + Sets the constraint of this DatabaseParameterSummary. + Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. + A `UNIQUE` parameter is one which is unique to each Oracle Real Application + Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER` + must have different values in each instance. An `IDENTICAL` parameter must + have the same value for every instance. For example, the parameter + `DB_BLOCK_SIZE` must have the same value in all instances. + + + :param constraint: The constraint of this DatabaseParameterSummary. + :type: str + """ + allowed_values = ["UNIQUE", "IDENTICAL", "NONE"] + if not value_allowed_none_or_none_sentinel(constraint, allowed_values): + constraint = 'UNKNOWN_ENUM_VALUE' + self._constraint = constraint + + @property + def sid(self): + """ + Gets the sid of this DatabaseParameterSummary. + The database instance SID for which the parameter is defined. + + + :return: The sid of this DatabaseParameterSummary. + :rtype: str + """ + return self._sid + + @sid.setter + def sid(self, sid): + """ + Sets the sid of this DatabaseParameterSummary. + The database instance SID for which the parameter is defined. + + + :param sid: The sid of this DatabaseParameterSummary. + :type: str + """ + self._sid = sid + + @property + def is_specified(self): + """ + Gets the is_specified of this DatabaseParameterSummary. + Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`. + + + :return: The is_specified of this DatabaseParameterSummary. + :rtype: bool + """ + return self._is_specified + + @is_specified.setter + def is_specified(self, is_specified): + """ + Sets the is_specified of this DatabaseParameterSummary. + Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`. + + + :param is_specified: The is_specified of this DatabaseParameterSummary. + :type: bool + """ + self._is_specified = is_specified + + @property + def allowed_values(self): + """ + Gets the allowed_values of this DatabaseParameterSummary. + A list of allowed values for this parameter. + + + :return: The allowed_values of this DatabaseParameterSummary. + :rtype: list[oci.database_management.models.AllowedParameterValue] + """ + return self._allowed_values + + @allowed_values.setter + def allowed_values(self, allowed_values): + """ + Sets the allowed_values of this DatabaseParameterSummary. + A list of allowed values for this parameter. + + + :param allowed_values: The allowed_values of this DatabaseParameterSummary. + :type: list[oci.database_management.models.AllowedParameterValue] + """ + self._allowed_values = allowed_values + + 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/database_management/models/database_parameter_update_status.py b/src/oci/database_management/models/database_parameter_update_status.py new file mode 100644 index 0000000000..d73acd7ae7 --- /dev/null +++ b/src/oci/database_management/models/database_parameter_update_status.py @@ -0,0 +1,152 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DatabaseParameterUpdateStatus(object): + """ + The result of database parameter update. + """ + + #: A constant which can be used with the status property of a DatabaseParameterUpdateStatus. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a DatabaseParameterUpdateStatus. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new DatabaseParameterUpdateStatus object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this DatabaseParameterUpdateStatus. + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param error_code: + The value to assign to the error_code property of this DatabaseParameterUpdateStatus. + :type error_code: str + + :param error_message: + The value to assign to the error_message property of this DatabaseParameterUpdateStatus. + :type error_message: str + + """ + self.swagger_types = { + 'status': 'str', + 'error_code': 'str', + 'error_message': 'str' + } + + self.attribute_map = { + 'status': 'status', + 'error_code': 'errorCode', + 'error_message': 'errorMessage' + } + + self._status = None + self._error_code = None + self._error_message = None + + @property + def status(self): + """ + Gets the status of this DatabaseParameterUpdateStatus. + The status of the parameter update. + + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this DatabaseParameterUpdateStatus. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this DatabaseParameterUpdateStatus. + The status of the parameter update. + + + :param status: The status of this DatabaseParameterUpdateStatus. + :type: str + """ + allowed_values = ["SUCCEEDED", "FAILED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def error_code(self): + """ + Gets the error_code of this DatabaseParameterUpdateStatus. + An error code that defines the failure or `null` if the parameter + was updated successfully. + + + :return: The error_code of this DatabaseParameterUpdateStatus. + :rtype: str + """ + return self._error_code + + @error_code.setter + def error_code(self, error_code): + """ + Sets the error_code of this DatabaseParameterUpdateStatus. + An error code that defines the failure or `null` if the parameter + was updated successfully. + + + :param error_code: The error_code of this DatabaseParameterUpdateStatus. + :type: str + """ + self._error_code = error_code + + @property + def error_message(self): + """ + Gets the error_message of this DatabaseParameterUpdateStatus. + The error message indicating the reason for failure or `null` if + the parameter was updated successfully. + + + :return: The error_message of this DatabaseParameterUpdateStatus. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this DatabaseParameterUpdateStatus. + The error message indicating the reason for failure or `null` if + the parameter was updated successfully. + + + :param error_message: The error_message of this DatabaseParameterUpdateStatus. + :type: str + """ + self._error_message = error_message + + 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/database_management/models/database_parameters_collection.py b/src/oci/database_management/models/database_parameters_collection.py new file mode 100644 index 0000000000..8bcece0ac4 --- /dev/null +++ b/src/oci/database_management/models/database_parameters_collection.py @@ -0,0 +1,232 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DatabaseParametersCollection(object): + """ + The details of the database parameters. + """ + + #: A constant which can be used with the database_type property of a DatabaseParametersCollection. + #: This constant has a value of "EXTERNAL_SIDB" + DATABASE_TYPE_EXTERNAL_SIDB = "EXTERNAL_SIDB" + + #: A constant which can be used with the database_type property of a DatabaseParametersCollection. + #: This constant has a value of "EXTERNAL_RAC" + DATABASE_TYPE_EXTERNAL_RAC = "EXTERNAL_RAC" + + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. + #: This constant has a value of "CDB" + DATABASE_SUB_TYPE_CDB = "CDB" + + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. + #: This constant has a value of "PDB" + DATABASE_SUB_TYPE_PDB = "PDB" + + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. + #: This constant has a value of "NON_CDB" + DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + + def __init__(self, **kwargs): + """ + Initializes a new DatabaseParametersCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param database_name: + The value to assign to the database_name property of this DatabaseParametersCollection. + :type database_name: str + + :param database_type: + The value to assign to the database_type property of this DatabaseParametersCollection. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type database_type: str + + :param database_sub_type: + The value to assign to the database_sub_type property of this DatabaseParametersCollection. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type database_sub_type: str + + :param database_version: + The value to assign to the database_version property of this DatabaseParametersCollection. + :type database_version: str + + :param items: + The value to assign to the items property of this DatabaseParametersCollection. + :type items: list[oci.database_management.models.DatabaseParameterSummary] + + """ + self.swagger_types = { + 'database_name': 'str', + 'database_type': 'str', + 'database_sub_type': 'str', + 'database_version': 'str', + 'items': 'list[DatabaseParameterSummary]' + } + + self.attribute_map = { + 'database_name': 'databaseName', + 'database_type': 'databaseType', + 'database_sub_type': 'databaseSubType', + 'database_version': 'databaseVersion', + 'items': 'items' + } + + self._database_name = None + self._database_type = None + self._database_sub_type = None + self._database_version = None + self._items = None + + @property + def database_name(self): + """ + **[Required]** Gets the database_name of this DatabaseParametersCollection. + The name of the Managed Database. + + + :return: The database_name of this DatabaseParametersCollection. + :rtype: str + """ + return self._database_name + + @database_name.setter + def database_name(self, database_name): + """ + Sets the database_name of this DatabaseParametersCollection. + The name of the Managed Database. + + + :param database_name: The database_name of this DatabaseParametersCollection. + :type: str + """ + self._database_name = database_name + + @property + def database_type(self): + """ + **[Required]** Gets the database_type of this DatabaseParametersCollection. + The type of Oracle Database installation. + + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_type of this DatabaseParametersCollection. + :rtype: str + """ + return self._database_type + + @database_type.setter + def database_type(self, database_type): + """ + Sets the database_type of this DatabaseParametersCollection. + The type of Oracle Database installation. + + + :param database_type: The database_type of this DatabaseParametersCollection. + :type: str + """ + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC"] + if not value_allowed_none_or_none_sentinel(database_type, allowed_values): + database_type = 'UNKNOWN_ENUM_VALUE' + self._database_type = database_type + + @property + def database_sub_type(self): + """ + **[Required]** Gets the database_sub_type of this DatabaseParametersCollection. + The subtype of the Oracle Database. Indicates whether the database + is a Container Database, Pluggable Database, or a Non-container Database. + + Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_sub_type of this DatabaseParametersCollection. + :rtype: str + """ + return self._database_sub_type + + @database_sub_type.setter + def database_sub_type(self, database_sub_type): + """ + Sets the database_sub_type of this DatabaseParametersCollection. + The subtype of the Oracle Database. Indicates whether the database + is a Container Database, Pluggable Database, or a Non-container Database. + + + :param database_sub_type: The database_sub_type of this DatabaseParametersCollection. + :type: str + """ + allowed_values = ["CDB", "PDB", "NON_CDB"] + if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): + database_sub_type = 'UNKNOWN_ENUM_VALUE' + self._database_sub_type = database_sub_type + + @property + def database_version(self): + """ + **[Required]** Gets the database_version of this DatabaseParametersCollection. + The Oracle Database version. + + + :return: The database_version of this DatabaseParametersCollection. + :rtype: str + """ + return self._database_version + + @database_version.setter + def database_version(self, database_version): + """ + Sets the database_version of this DatabaseParametersCollection. + The Oracle Database version. + + + :param database_version: The database_version of this DatabaseParametersCollection. + :type: str + """ + self._database_version = database_version + + @property + def items(self): + """ + **[Required]** Gets the items of this DatabaseParametersCollection. + An array of DatabaseParameterSummary objects. + + + :return: The items of this DatabaseParametersCollection. + :rtype: list[oci.database_management.models.DatabaseParameterSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DatabaseParametersCollection. + An array of DatabaseParameterSummary objects. + + + :param items: The items of this DatabaseParametersCollection. + :type: list[oci.database_management.models.DatabaseParameterSummary] + """ + self._items = items + + 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/database_management/models/datafile.py b/src/oci/database_management/models/datafile.py new file mode 100644 index 0000000000..7b313019cb --- /dev/null +++ b/src/oci/database_management/models/datafile.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Datafile(object): + """ + The details of a datafile. + """ + + #: A constant which can be used with the status property of a Datafile. + #: This constant has a value of "AVAILABLE" + STATUS_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the status property of a Datafile. + #: This constant has a value of "INVALID" + STATUS_INVALID = "INVALID" + + #: A constant which can be used with the status property of a Datafile. + #: This constant has a value of "OFFLINE" + STATUS_OFFLINE = "OFFLINE" + + #: A constant which can be used with the status property of a Datafile. + #: This constant has a value of "ONLINE" + STATUS_ONLINE = "ONLINE" + + #: A constant which can be used with the status property of a Datafile. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" + + #: A constant which can be used with the online_status property of a Datafile. + #: This constant has a value of "SYSOFF" + ONLINE_STATUS_SYSOFF = "SYSOFF" + + #: A constant which can be used with the online_status property of a Datafile. + #: This constant has a value of "SYSTEM" + ONLINE_STATUS_SYSTEM = "SYSTEM" + + #: A constant which can be used with the online_status property of a Datafile. + #: This constant has a value of "OFFLINE" + ONLINE_STATUS_OFFLINE = "OFFLINE" + + #: A constant which can be used with the online_status property of a Datafile. + #: This constant has a value of "ONLINE" + ONLINE_STATUS_ONLINE = "ONLINE" + + #: A constant which can be used with the online_status property of a Datafile. + #: This constant has a value of "RECOVER" + ONLINE_STATUS_RECOVER = "RECOVER" + + #: A constant which can be used with the lost_write_protect property of a Datafile. + #: This constant has a value of "ENABLED" + LOST_WRITE_PROTECT_ENABLED = "ENABLED" + + #: A constant which can be used with the lost_write_protect property of a Datafile. + #: This constant has a value of "PROTECT_OFF" + LOST_WRITE_PROTECT_PROTECT_OFF = "PROTECT_OFF" + + #: A constant which can be used with the lost_write_protect property of a Datafile. + #: This constant has a value of "SUSPEND" + LOST_WRITE_PROTECT_SUSPEND = "SUSPEND" + + #: A constant which can be used with the shared property of a Datafile. + #: This constant has a value of "SHARED" + SHARED_SHARED = "SHARED" + + #: A constant which can be used with the shared property of a Datafile. + #: This constant has a value of "LOCAL_FOR_RIM" + SHARED_LOCAL_FOR_RIM = "LOCAL_FOR_RIM" + + #: A constant which can be used with the shared property of a Datafile. + #: This constant has a value of "LOCAL_FOR_ALL" + SHARED_LOCAL_FOR_ALL = "LOCAL_FOR_ALL" + + def __init__(self, **kwargs): + """ + Initializes a new Datafile 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 Datafile. + :type name: str + + :param status: + The value to assign to the status property of this Datafile. + Allowed values for this property are: "AVAILABLE", "INVALID", "OFFLINE", "ONLINE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param online_status: + The value to assign to the online_status property of this Datafile. + Allowed values for this property are: "SYSOFF", "SYSTEM", "OFFLINE", "ONLINE", "RECOVER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type online_status: str + + :param is_auto_extensible: + The value to assign to the is_auto_extensible property of this Datafile. + :type is_auto_extensible: bool + + :param lost_write_protect: + The value to assign to the lost_write_protect property of this Datafile. + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lost_write_protect: str + + :param shared: + The value to assign to the shared property of this Datafile. + Allowed values for this property are: "SHARED", "LOCAL_FOR_RIM", "LOCAL_FOR_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type shared: str + + :param instance_id: + The value to assign to the instance_id property of this Datafile. + :type instance_id: float + + :param max_size_kb: + The value to assign to the max_size_kb property of this Datafile. + :type max_size_kb: float + + :param allocated_size_kb: + The value to assign to the allocated_size_kb property of this Datafile. + :type allocated_size_kb: float + + :param user_size_kb: + The value to assign to the user_size_kb property of this Datafile. + :type user_size_kb: float + + :param increment_by: + The value to assign to the increment_by property of this Datafile. + :type increment_by: float + + :param free_space_kb: + The value to assign to the free_space_kb property of this Datafile. + :type free_space_kb: float + + :param used_space_kb: + The value to assign to the used_space_kb property of this Datafile. + :type used_space_kb: float + + :param used_percent_available: + The value to assign to the used_percent_available property of this Datafile. + :type used_percent_available: float + + :param used_percent_allocated: + The value to assign to the used_percent_allocated property of this Datafile. + :type used_percent_allocated: float + + """ + self.swagger_types = { + 'name': 'str', + 'status': 'str', + 'online_status': 'str', + 'is_auto_extensible': 'bool', + 'lost_write_protect': 'str', + 'shared': 'str', + 'instance_id': 'float', + 'max_size_kb': 'float', + 'allocated_size_kb': 'float', + 'user_size_kb': 'float', + 'increment_by': 'float', + 'free_space_kb': 'float', + 'used_space_kb': 'float', + 'used_percent_available': 'float', + 'used_percent_allocated': 'float' + } + + self.attribute_map = { + 'name': 'name', + 'status': 'status', + 'online_status': 'onlineStatus', + 'is_auto_extensible': 'isAutoExtensible', + 'lost_write_protect': 'lostWriteProtect', + 'shared': 'shared', + 'instance_id': 'instanceId', + 'max_size_kb': 'maxSizeKB', + 'allocated_size_kb': 'allocatedSizeKB', + 'user_size_kb': 'userSizeKB', + 'increment_by': 'incrementBy', + 'free_space_kb': 'freeSpaceKB', + 'used_space_kb': 'usedSpaceKB', + 'used_percent_available': 'usedPercentAvailable', + 'used_percent_allocated': 'usedPercentAllocated' + } + + self._name = None + self._status = None + self._online_status = None + self._is_auto_extensible = None + self._lost_write_protect = None + self._shared = None + self._instance_id = None + self._max_size_kb = None + self._allocated_size_kb = None + self._user_size_kb = None + self._increment_by = None + self._free_space_kb = None + self._used_space_kb = None + self._used_percent_available = None + self._used_percent_allocated = None + + @property + def name(self): + """ + **[Required]** Gets the name of this Datafile. + The filename (including the path) of the datafile or tempfile. + + + :return: The name of this Datafile. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Datafile. + The filename (including the path) of the datafile or tempfile. + + + :param name: The name of this Datafile. + :type: str + """ + self._name = name + + @property + def status(self): + """ + Gets the status of this Datafile. + The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was dropped. + + Allowed values for this property are: "AVAILABLE", "INVALID", "OFFLINE", "ONLINE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this Datafile. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this Datafile. + The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was dropped. + + + :param status: The status of this Datafile. + :type: str + """ + allowed_values = ["AVAILABLE", "INVALID", "OFFLINE", "ONLINE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def online_status(self): + """ + Gets the online_status of this Datafile. + The online status of the file. + + Allowed values for this property are: "SYSOFF", "SYSTEM", "OFFLINE", "ONLINE", "RECOVER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The online_status of this Datafile. + :rtype: str + """ + return self._online_status + + @online_status.setter + def online_status(self, online_status): + """ + Sets the online_status of this Datafile. + The online status of the file. + + + :param online_status: The online_status of this Datafile. + :type: str + """ + allowed_values = ["SYSOFF", "SYSTEM", "OFFLINE", "ONLINE", "RECOVER"] + if not value_allowed_none_or_none_sentinel(online_status, allowed_values): + online_status = 'UNKNOWN_ENUM_VALUE' + self._online_status = online_status + + @property + def is_auto_extensible(self): + """ + Gets the is_auto_extensible of this Datafile. + Indicates whether the datafile is auto-extensible. + + + :return: The is_auto_extensible of this Datafile. + :rtype: bool + """ + return self._is_auto_extensible + + @is_auto_extensible.setter + def is_auto_extensible(self, is_auto_extensible): + """ + Sets the is_auto_extensible of this Datafile. + Indicates whether the datafile is auto-extensible. + + + :param is_auto_extensible: The is_auto_extensible of this Datafile. + :type: bool + """ + self._is_auto_extensible = is_auto_extensible + + @property + def lost_write_protect(self): + """ + Gets the lost_write_protect of this Datafile. + The lost write protection status of the file. + + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lost_write_protect of this Datafile. + :rtype: str + """ + return self._lost_write_protect + + @lost_write_protect.setter + def lost_write_protect(self, lost_write_protect): + """ + Sets the lost_write_protect of this Datafile. + The lost write protection status of the file. + + + :param lost_write_protect: The lost_write_protect of this Datafile. + :type: str + """ + allowed_values = ["ENABLED", "PROTECT_OFF", "SUSPEND"] + if not value_allowed_none_or_none_sentinel(lost_write_protect, allowed_values): + lost_write_protect = 'UNKNOWN_ENUM_VALUE' + self._lost_write_protect = lost_write_protect + + @property + def shared(self): + """ + Gets the shared of this Datafile. + Type of tablespace this file belongs to. If it's for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types. + + Allowed values for this property are: "SHARED", "LOCAL_FOR_RIM", "LOCAL_FOR_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The shared of this Datafile. + :rtype: str + """ + return self._shared + + @shared.setter + def shared(self, shared): + """ + Sets the shared of this Datafile. + Type of tablespace this file belongs to. If it's for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types. + + + :param shared: The shared of this Datafile. + :type: str + """ + allowed_values = ["SHARED", "LOCAL_FOR_RIM", "LOCAL_FOR_ALL"] + if not value_allowed_none_or_none_sentinel(shared, allowed_values): + shared = 'UNKNOWN_ENUM_VALUE' + self._shared = shared + + @property + def instance_id(self): + """ + Gets the instance_id of this Datafile. + Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces. + + + :return: The instance_id of this Datafile. + :rtype: float + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this Datafile. + Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces. + + + :param instance_id: The instance_id of this Datafile. + :type: float + """ + self._instance_id = instance_id + + @property + def max_size_kb(self): + """ + Gets the max_size_kb of this Datafile. + The maximum file size in KB. + + + :return: The max_size_kb of this Datafile. + :rtype: float + """ + return self._max_size_kb + + @max_size_kb.setter + def max_size_kb(self, max_size_kb): + """ + Sets the max_size_kb of this Datafile. + The maximum file size in KB. + + + :param max_size_kb: The max_size_kb of this Datafile. + :type: float + """ + self._max_size_kb = max_size_kb + + @property + def allocated_size_kb(self): + """ + Gets the allocated_size_kb of this Datafile. + The allocated file size in KB. + + + :return: The allocated_size_kb of this Datafile. + :rtype: float + """ + return self._allocated_size_kb + + @allocated_size_kb.setter + def allocated_size_kb(self, allocated_size_kb): + """ + Sets the allocated_size_kb of this Datafile. + The allocated file size in KB. + + + :param allocated_size_kb: The allocated_size_kb of this Datafile. + :type: float + """ + self._allocated_size_kb = allocated_size_kb + + @property + def user_size_kb(self): + """ + Gets the user_size_kb of this Datafile. + The size of the file available for user data in KB. The actual size of the file minus the USER_BYTES value is used to store file-related metadata. + + + :return: The user_size_kb of this Datafile. + :rtype: float + """ + return self._user_size_kb + + @user_size_kb.setter + def user_size_kb(self, user_size_kb): + """ + Sets the user_size_kb of this Datafile. + The size of the file available for user data in KB. The actual size of the file minus the USER_BYTES value is used to store file-related metadata. + + + :param user_size_kb: The user_size_kb of this Datafile. + :type: float + """ + self._user_size_kb = user_size_kb + + @property + def increment_by(self): + """ + Gets the increment_by of this Datafile. + The number of blocks used as auto-extension increment. + + + :return: The increment_by of this Datafile. + :rtype: float + """ + return self._increment_by + + @increment_by.setter + def increment_by(self, increment_by): + """ + Sets the increment_by of this Datafile. + The number of blocks used as auto-extension increment. + + + :param increment_by: The increment_by of this Datafile. + :type: float + """ + self._increment_by = increment_by + + @property + def free_space_kb(self): + """ + Gets the free_space_kb of this Datafile. + The free space available in the datafile in KB. + + + :return: The free_space_kb of this Datafile. + :rtype: float + """ + return self._free_space_kb + + @free_space_kb.setter + def free_space_kb(self, free_space_kb): + """ + Sets the free_space_kb of this Datafile. + The free space available in the datafile in KB. + + + :param free_space_kb: The free_space_kb of this Datafile. + :type: float + """ + self._free_space_kb = free_space_kb + + @property + def used_space_kb(self): + """ + Gets the used_space_kb of this Datafile. + The total space used in the datafile in KB. + + + :return: The used_space_kb of this Datafile. + :rtype: float + """ + return self._used_space_kb + + @used_space_kb.setter + def used_space_kb(self, used_space_kb): + """ + Sets the used_space_kb of this Datafile. + The total space used in the datafile in KB. + + + :param used_space_kb: The used_space_kb of this Datafile. + :type: float + """ + self._used_space_kb = used_space_kb + + @property + def used_percent_available(self): + """ + Gets the used_percent_available of this Datafile. + The percentage of used space out of the maximum available space in the file. + + + :return: The used_percent_available of this Datafile. + :rtype: float + """ + return self._used_percent_available + + @used_percent_available.setter + def used_percent_available(self, used_percent_available): + """ + Sets the used_percent_available of this Datafile. + The percentage of used space out of the maximum available space in the file. + + + :param used_percent_available: The used_percent_available of this Datafile. + :type: float + """ + self._used_percent_available = used_percent_available + + @property + def used_percent_allocated(self): + """ + Gets the used_percent_allocated of this Datafile. + The percentage of used space out of the total allocated space in the file. + + + :return: The used_percent_allocated of this Datafile. + :rtype: float + """ + return self._used_percent_allocated + + @used_percent_allocated.setter + def used_percent_allocated(self, used_percent_allocated): + """ + Sets the used_percent_allocated of this Datafile. + The percentage of used space out of the total allocated space in the file. + + + :param used_percent_allocated: The used_percent_allocated of this Datafile. + :type: float + """ + self._used_percent_allocated = used_percent_allocated + + 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/database_management/models/reset_database_parameters_details.py b/src/oci/database_management/models/reset_database_parameters_details.py new file mode 100644 index 0000000000..53e8c7faa8 --- /dev/null +++ b/src/oci/database_management/models/reset_database_parameters_details.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResetDatabaseParametersDetails(object): + """ + The details required to reset database parameters' values. + """ + + #: A constant which can be used with the scope property of a ResetDatabaseParametersDetails. + #: This constant has a value of "MEMORY" + SCOPE_MEMORY = "MEMORY" + + #: A constant which can be used with the scope property of a ResetDatabaseParametersDetails. + #: This constant has a value of "SPFILE" + SCOPE_SPFILE = "SPFILE" + + #: A constant which can be used with the scope property of a ResetDatabaseParametersDetails. + #: This constant has a value of "BOTH" + SCOPE_BOTH = "BOTH" + + def __init__(self, **kwargs): + """ + Initializes a new ResetDatabaseParametersDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credentials: + The value to assign to the credentials property of this ResetDatabaseParametersDetails. + :type credentials: oci.database_management.models.DatabaseCredentials + + :param scope: + The value to assign to the scope property of this ResetDatabaseParametersDetails. + Allowed values for this property are: "MEMORY", "SPFILE", "BOTH" + :type scope: str + + :param parameters: + The value to assign to the parameters property of this ResetDatabaseParametersDetails. + :type parameters: list[str] + + """ + self.swagger_types = { + 'credentials': 'DatabaseCredentials', + 'scope': 'str', + 'parameters': 'list[str]' + } + + self.attribute_map = { + 'credentials': 'credentials', + 'scope': 'scope', + 'parameters': 'parameters' + } + + self._credentials = None + self._scope = None + self._parameters = None + + @property + def credentials(self): + """ + **[Required]** Gets the credentials of this ResetDatabaseParametersDetails. + + :return: The credentials of this ResetDatabaseParametersDetails. + :rtype: oci.database_management.models.DatabaseCredentials + """ + return self._credentials + + @credentials.setter + def credentials(self, credentials): + """ + Sets the credentials of this ResetDatabaseParametersDetails. + + :param credentials: The credentials of this ResetDatabaseParametersDetails. + :type: oci.database_management.models.DatabaseCredentials + """ + self._credentials = credentials + + @property + def scope(self): + """ + **[Required]** Gets the scope of this ResetDatabaseParametersDetails. + The clause used to specify when the parameter change takes effect. + + Use `MEMORY` to make the change in memory and affect it immediately. + Use `SPFILE` to make the change in the server parameter file. The + change takes effect when the database is next shut down and started + up again. Use `BOTH` to make the change in memory and in the server + parameter file. The change takes effect immediately and persists + after the database is shut down and started up again. + + Allowed values for this property are: "MEMORY", "SPFILE", "BOTH" + + + :return: The scope of this ResetDatabaseParametersDetails. + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """ + Sets the scope of this ResetDatabaseParametersDetails. + The clause used to specify when the parameter change takes effect. + + Use `MEMORY` to make the change in memory and affect it immediately. + Use `SPFILE` to make the change in the server parameter file. The + change takes effect when the database is next shut down and started + up again. Use `BOTH` to make the change in memory and in the server + parameter file. The change takes effect immediately and persists + after the database is shut down and started up again. + + + :param scope: The scope of this ResetDatabaseParametersDetails. + :type: str + """ + allowed_values = ["MEMORY", "SPFILE", "BOTH"] + if not value_allowed_none_or_none_sentinel(scope, allowed_values): + raise ValueError( + "Invalid value for `scope`, must be None or one of {0}" + .format(allowed_values) + ) + self._scope = scope + + @property + def parameters(self): + """ + **[Required]** Gets the parameters of this ResetDatabaseParametersDetails. + A list of database parameter names. + + + :return: The parameters of this ResetDatabaseParametersDetails. + :rtype: list[str] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this ResetDatabaseParametersDetails. + A list of database parameter names. + + + :param parameters: The parameters of this ResetDatabaseParametersDetails. + :type: list[str] + """ + self._parameters = parameters + + 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/database_management/models/tablespace.py b/src/oci/database_management/models/tablespace.py new file mode 100644 index 0000000000..bec0a658d1 --- /dev/null +++ b/src/oci/database_management/models/tablespace.py @@ -0,0 +1,1657 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Tablespace(object): + """ + The details of a tablespace. + """ + + #: A constant which can be used with the type property of a Tablespace. + #: This constant has a value of "UNDO" + TYPE_UNDO = "UNDO" + + #: A constant which can be used with the type property of a Tablespace. + #: This constant has a value of "LOST_WRITE_PROTECTION" + TYPE_LOST_WRITE_PROTECTION = "LOST_WRITE_PROTECTION" + + #: A constant which can be used with the type property of a Tablespace. + #: This constant has a value of "PERMANENT" + TYPE_PERMANENT = "PERMANENT" + + #: A constant which can be used with the type property of a Tablespace. + #: This constant has a value of "TEMPORARY" + TYPE_TEMPORARY = "TEMPORARY" + + #: A constant which can be used with the status property of a Tablespace. + #: This constant has a value of "ONLINE" + STATUS_ONLINE = "ONLINE" + + #: A constant which can be used with the status property of a Tablespace. + #: This constant has a value of "OFFLINE" + STATUS_OFFLINE = "OFFLINE" + + #: A constant which can be used with the status property of a Tablespace. + #: This constant has a value of "READ_ONLY" + STATUS_READ_ONLY = "READ_ONLY" + + #: A constant which can be used with the logging property of a Tablespace. + #: This constant has a value of "LOGGING" + LOGGING_LOGGING = "LOGGING" + + #: A constant which can be used with the logging property of a Tablespace. + #: This constant has a value of "NOLOGGING" + LOGGING_NOLOGGING = "NOLOGGING" + + #: A constant which can be used with the extent_management property of a Tablespace. + #: This constant has a value of "LOCAL" + EXTENT_MANAGEMENT_LOCAL = "LOCAL" + + #: A constant which can be used with the extent_management property of a Tablespace. + #: This constant has a value of "DICTIONARY" + EXTENT_MANAGEMENT_DICTIONARY = "DICTIONARY" + + #: A constant which can be used with the allocation_type property of a Tablespace. + #: This constant has a value of "SYSTEM" + ALLOCATION_TYPE_SYSTEM = "SYSTEM" + + #: A constant which can be used with the allocation_type property of a Tablespace. + #: This constant has a value of "UNIFORM" + ALLOCATION_TYPE_UNIFORM = "UNIFORM" + + #: A constant which can be used with the allocation_type property of a Tablespace. + #: This constant has a value of "USER" + ALLOCATION_TYPE_USER = "USER" + + #: A constant which can be used with the segment_space_management property of a Tablespace. + #: This constant has a value of "MANUAL" + SEGMENT_SPACE_MANAGEMENT_MANUAL = "MANUAL" + + #: A constant which can be used with the segment_space_management property of a Tablespace. + #: This constant has a value of "AUTO" + SEGMENT_SPACE_MANAGEMENT_AUTO = "AUTO" + + #: A constant which can be used with the default_table_compression property of a Tablespace. + #: This constant has a value of "ENABLED" + DEFAULT_TABLE_COMPRESSION_ENABLED = "ENABLED" + + #: A constant which can be used with the default_table_compression property of a Tablespace. + #: This constant has a value of "DISABLED" + DEFAULT_TABLE_COMPRESSION_DISABLED = "DISABLED" + + #: A constant which can be used with the retention property of a Tablespace. + #: This constant has a value of "GUARANTEE" + RETENTION_GUARANTEE = "GUARANTEE" + + #: A constant which can be used with the retention property of a Tablespace. + #: This constant has a value of "NOGUARANTEE" + RETENTION_NOGUARANTEE = "NOGUARANTEE" + + #: A constant which can be used with the retention property of a Tablespace. + #: This constant has a value of "NOT_APPLY" + RETENTION_NOT_APPLY = "NOT_APPLY" + + #: A constant which can be used with the predicate_evaluation property of a Tablespace. + #: This constant has a value of "HOST" + PREDICATE_EVALUATION_HOST = "HOST" + + #: A constant which can be used with the predicate_evaluation property of a Tablespace. + #: This constant has a value of "STORAGE" + PREDICATE_EVALUATION_STORAGE = "STORAGE" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "BASIC" + COMPRESS_FOR_BASIC = "BASIC" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "ADVANCED" + COMPRESS_FOR_ADVANCED = "ADVANCED" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "QUERY_LOW" + COMPRESS_FOR_QUERY_LOW = "QUERY_LOW" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "QUERY_HIGH" + COMPRESS_FOR_QUERY_HIGH = "QUERY_HIGH" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "ARCHIVE_LOW" + COMPRESS_FOR_ARCHIVE_LOW = "ARCHIVE_LOW" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "ARCHIVE_HIGH" + COMPRESS_FOR_ARCHIVE_HIGH = "ARCHIVE_HIGH" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "DIRECT_LOAD_ONLY" + COMPRESS_FOR_DIRECT_LOAD_ONLY = "DIRECT_LOAD_ONLY" + + #: A constant which can be used with the compress_for property of a Tablespace. + #: This constant has a value of "FOR_ALL_OPERATIONS" + COMPRESS_FOR_FOR_ALL_OPERATIONS = "FOR_ALL_OPERATIONS" + + #: A constant which can be used with the default_in_memory property of a Tablespace. + #: This constant has a value of "ENABLED" + DEFAULT_IN_MEMORY_ENABLED = "ENABLED" + + #: A constant which can be used with the default_in_memory property of a Tablespace. + #: This constant has a value of "DISABLED" + DEFAULT_IN_MEMORY_DISABLED = "DISABLED" + + #: A constant which can be used with the default_in_memory_priority property of a Tablespace. + #: This constant has a value of "LOW" + DEFAULT_IN_MEMORY_PRIORITY_LOW = "LOW" + + #: A constant which can be used with the default_in_memory_priority property of a Tablespace. + #: This constant has a value of "MEDIUM" + DEFAULT_IN_MEMORY_PRIORITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the default_in_memory_priority property of a Tablespace. + #: This constant has a value of "HIGH" + DEFAULT_IN_MEMORY_PRIORITY_HIGH = "HIGH" + + #: A constant which can be used with the default_in_memory_priority property of a Tablespace. + #: This constant has a value of "CRITICAL" + DEFAULT_IN_MEMORY_PRIORITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the default_in_memory_priority property of a Tablespace. + #: This constant has a value of "NONE" + DEFAULT_IN_MEMORY_PRIORITY_NONE = "NONE" + + #: A constant which can be used with the default_in_memory_distribute property of a Tablespace. + #: This constant has a value of "AUTO" + DEFAULT_IN_MEMORY_DISTRIBUTE_AUTO = "AUTO" + + #: A constant which can be used with the default_in_memory_distribute property of a Tablespace. + #: This constant has a value of "BY_ROWID_RANGE" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_ROWID_RANGE = "BY_ROWID_RANGE" + + #: A constant which can be used with the default_in_memory_distribute property of a Tablespace. + #: This constant has a value of "BY_PARTITION" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_PARTITION = "BY_PARTITION" + + #: A constant which can be used with the default_in_memory_distribute property of a Tablespace. + #: This constant has a value of "BY_SUBPARTITION" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_SUBPARTITION = "BY_SUBPARTITION" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "NO_MEMCOMPRESS" + DEFAULT_IN_MEMORY_COMPRESSION_NO_MEMCOMPRESS = "NO_MEMCOMPRESS" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "FOR_DML" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_DML = "FOR_DML" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "FOR_QUERY_LOW" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_QUERY_LOW = "FOR_QUERY_LOW" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "FOR_QUERY_HIGH" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_QUERY_HIGH = "FOR_QUERY_HIGH" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "FOR_CAPACITY_LOW" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_CAPACITY_LOW = "FOR_CAPACITY_LOW" + + #: A constant which can be used with the default_in_memory_compression property of a Tablespace. + #: This constant has a value of "FOR_CAPACITY_HIGH" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_CAPACITY_HIGH = "FOR_CAPACITY_HIGH" + + #: A constant which can be used with the default_in_memory_duplicate property of a Tablespace. + #: This constant has a value of "NO_DUPLICATE" + DEFAULT_IN_MEMORY_DUPLICATE_NO_DUPLICATE = "NO_DUPLICATE" + + #: A constant which can be used with the default_in_memory_duplicate property of a Tablespace. + #: This constant has a value of "DUPLICATE" + DEFAULT_IN_MEMORY_DUPLICATE_DUPLICATE = "DUPLICATE" + + #: A constant which can be used with the default_in_memory_duplicate property of a Tablespace. + #: This constant has a value of "DUPLICATE_ALL" + DEFAULT_IN_MEMORY_DUPLICATE_DUPLICATE_ALL = "DUPLICATE_ALL" + + #: A constant which can be used with the shared property of a Tablespace. + #: This constant has a value of "SHARED" + SHARED_SHARED = "SHARED" + + #: A constant which can be used with the shared property of a Tablespace. + #: This constant has a value of "LOCAL_ON_LEAF" + SHARED_LOCAL_ON_LEAF = "LOCAL_ON_LEAF" + + #: A constant which can be used with the shared property of a Tablespace. + #: This constant has a value of "LOCAL_ON_ALL" + SHARED_LOCAL_ON_ALL = "LOCAL_ON_ALL" + + #: A constant which can be used with the default_index_compression property of a Tablespace. + #: This constant has a value of "ENABLED" + DEFAULT_INDEX_COMPRESSION_ENABLED = "ENABLED" + + #: A constant which can be used with the default_index_compression property of a Tablespace. + #: This constant has a value of "DISABLED" + DEFAULT_INDEX_COMPRESSION_DISABLED = "DISABLED" + + #: A constant which can be used with the index_compress_for property of a Tablespace. + #: This constant has a value of "ADVANCED_LOW" + INDEX_COMPRESS_FOR_ADVANCED_LOW = "ADVANCED_LOW" + + #: A constant which can be used with the index_compress_for property of a Tablespace. + #: This constant has a value of "ADVANCED_HIGH" + INDEX_COMPRESS_FOR_ADVANCED_HIGH = "ADVANCED_HIGH" + + #: A constant which can be used with the default_in_memory_service property of a Tablespace. + #: This constant has a value of "DEFAULT" + DEFAULT_IN_MEMORY_SERVICE_DEFAULT = "DEFAULT" + + #: A constant which can be used with the default_in_memory_service property of a Tablespace. + #: This constant has a value of "NONE" + DEFAULT_IN_MEMORY_SERVICE_NONE = "NONE" + + #: A constant which can be used with the default_in_memory_service property of a Tablespace. + #: This constant has a value of "ALL" + DEFAULT_IN_MEMORY_SERVICE_ALL = "ALL" + + #: A constant which can be used with the default_in_memory_service property of a Tablespace. + #: This constant has a value of "USER_DEFINED" + DEFAULT_IN_MEMORY_SERVICE_USER_DEFINED = "USER_DEFINED" + + #: A constant which can be used with the lost_write_protect property of a Tablespace. + #: This constant has a value of "ENABLED" + LOST_WRITE_PROTECT_ENABLED = "ENABLED" + + #: A constant which can be used with the lost_write_protect property of a Tablespace. + #: This constant has a value of "PROTECT_OFF" + LOST_WRITE_PROTECT_PROTECT_OFF = "PROTECT_OFF" + + #: A constant which can be used with the lost_write_protect property of a Tablespace. + #: This constant has a value of "SUSPEND" + LOST_WRITE_PROTECT_SUSPEND = "SUSPEND" + + def __init__(self, **kwargs): + """ + Initializes a new Tablespace 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 Tablespace. + :type name: str + + :param type: + The value to assign to the type property of this Tablespace. + Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY" + :type type: str + + :param status: + The value to assign to the status property of this Tablespace. + Allowed values for this property are: "ONLINE", "OFFLINE", "READ_ONLY" + :type status: str + + :param block_size_bytes: + The value to assign to the block_size_bytes property of this Tablespace. + :type block_size_bytes: float + + :param logging: + The value to assign to the logging property of this Tablespace. + Allowed values for this property are: "LOGGING", "NOLOGGING" + :type logging: str + + :param is_force_logging: + The value to assign to the is_force_logging property of this Tablespace. + :type is_force_logging: bool + + :param extent_management: + The value to assign to the extent_management property of this Tablespace. + Allowed values for this property are: "LOCAL", "DICTIONARY" + :type extent_management: str + + :param allocation_type: + The value to assign to the allocation_type property of this Tablespace. + Allowed values for this property are: "SYSTEM", "UNIFORM", "USER" + :type allocation_type: str + + :param is_plugged_in: + The value to assign to the is_plugged_in property of this Tablespace. + :type is_plugged_in: bool + + :param segment_space_management: + The value to assign to the segment_space_management property of this Tablespace. + Allowed values for this property are: "MANUAL", "AUTO" + :type segment_space_management: str + + :param default_table_compression: + The value to assign to the default_table_compression property of this Tablespace. + Allowed values for this property are: "ENABLED", "DISABLED" + :type default_table_compression: str + + :param retention: + The value to assign to the retention property of this Tablespace. + Allowed values for this property are: "GUARANTEE", "NOGUARANTEE", "NOT_APPLY" + :type retention: str + + :param is_bigfile: + The value to assign to the is_bigfile property of this Tablespace. + :type is_bigfile: bool + + :param predicate_evaluation: + The value to assign to the predicate_evaluation property of this Tablespace. + Allowed values for this property are: "HOST", "STORAGE" + :type predicate_evaluation: str + + :param is_encrypted: + The value to assign to the is_encrypted property of this Tablespace. + :type is_encrypted: bool + + :param compress_for: + The value to assign to the compress_for property of this Tablespace. + Allowed values for this property are: "BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS" + :type compress_for: str + + :param default_in_memory: + The value to assign to the default_in_memory property of this Tablespace. + Allowed values for this property are: "ENABLED", "DISABLED" + :type default_in_memory: str + + :param default_in_memory_priority: + The value to assign to the default_in_memory_priority property of this Tablespace. + Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE" + :type default_in_memory_priority: str + + :param default_in_memory_distribute: + The value to assign to the default_in_memory_distribute property of this Tablespace. + Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION" + :type default_in_memory_distribute: str + + :param default_in_memory_compression: + The value to assign to the default_in_memory_compression property of this Tablespace. + Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH" + :type default_in_memory_compression: str + + :param default_in_memory_duplicate: + The value to assign to the default_in_memory_duplicate property of this Tablespace. + Allowed values for this property are: "NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL" + :type default_in_memory_duplicate: str + + :param shared: + The value to assign to the shared property of this Tablespace. + Allowed values for this property are: "SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL" + :type shared: str + + :param default_index_compression: + The value to assign to the default_index_compression property of this Tablespace. + Allowed values for this property are: "ENABLED", "DISABLED" + :type default_index_compression: str + + :param index_compress_for: + The value to assign to the index_compress_for property of this Tablespace. + Allowed values for this property are: "ADVANCED_LOW", "ADVANCED_HIGH" + :type index_compress_for: str + + :param default_cell_memory: + The value to assign to the default_cell_memory property of this Tablespace. + :type default_cell_memory: str + + :param default_in_memory_service: + The value to assign to the default_in_memory_service property of this Tablespace. + Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED" + :type default_in_memory_service: str + + :param default_in_memory_service_name: + The value to assign to the default_in_memory_service_name property of this Tablespace. + :type default_in_memory_service_name: str + + :param lost_write_protect: + The value to assign to the lost_write_protect property of this Tablespace. + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND" + :type lost_write_protect: str + + :param is_chunk_tablespace: + The value to assign to the is_chunk_tablespace property of this Tablespace. + :type is_chunk_tablespace: bool + + :param temp_group: + The value to assign to the temp_group property of this Tablespace. + :type temp_group: str + + :param max_size_kb: + The value to assign to the max_size_kb property of this Tablespace. + :type max_size_kb: float + + :param allocated_size_kb: + The value to assign to the allocated_size_kb property of this Tablespace. + :type allocated_size_kb: float + + :param user_size_kb: + The value to assign to the user_size_kb property of this Tablespace. + :type user_size_kb: float + + :param free_space_kb: + The value to assign to the free_space_kb property of this Tablespace. + :type free_space_kb: float + + :param used_space_kb: + The value to assign to the used_space_kb property of this Tablespace. + :type used_space_kb: float + + :param used_percent_available: + The value to assign to the used_percent_available property of this Tablespace. + :type used_percent_available: float + + :param used_percent_allocated: + The value to assign to the used_percent_allocated property of this Tablespace. + :type used_percent_allocated: float + + :param datafiles: + The value to assign to the datafiles property of this Tablespace. + :type datafiles: list[oci.database_management.models.Datafile] + + """ + self.swagger_types = { + 'name': 'str', + 'type': 'str', + 'status': 'str', + 'block_size_bytes': 'float', + 'logging': 'str', + 'is_force_logging': 'bool', + 'extent_management': 'str', + 'allocation_type': 'str', + 'is_plugged_in': 'bool', + 'segment_space_management': 'str', + 'default_table_compression': 'str', + 'retention': 'str', + 'is_bigfile': 'bool', + 'predicate_evaluation': 'str', + 'is_encrypted': 'bool', + 'compress_for': 'str', + 'default_in_memory': 'str', + 'default_in_memory_priority': 'str', + 'default_in_memory_distribute': 'str', + 'default_in_memory_compression': 'str', + 'default_in_memory_duplicate': 'str', + 'shared': 'str', + 'default_index_compression': 'str', + 'index_compress_for': 'str', + 'default_cell_memory': 'str', + 'default_in_memory_service': 'str', + 'default_in_memory_service_name': 'str', + 'lost_write_protect': 'str', + 'is_chunk_tablespace': 'bool', + 'temp_group': 'str', + 'max_size_kb': 'float', + 'allocated_size_kb': 'float', + 'user_size_kb': 'float', + 'free_space_kb': 'float', + 'used_space_kb': 'float', + 'used_percent_available': 'float', + 'used_percent_allocated': 'float', + 'datafiles': 'list[Datafile]' + } + + self.attribute_map = { + 'name': 'name', + 'type': 'type', + 'status': 'status', + 'block_size_bytes': 'blockSizeBytes', + 'logging': 'logging', + 'is_force_logging': 'isForceLogging', + 'extent_management': 'extentManagement', + 'allocation_type': 'allocationType', + 'is_plugged_in': 'isPluggedIn', + 'segment_space_management': 'segmentSpaceManagement', + 'default_table_compression': 'defaultTableCompression', + 'retention': 'retention', + 'is_bigfile': 'isBigfile', + 'predicate_evaluation': 'predicateEvaluation', + 'is_encrypted': 'isEncrypted', + 'compress_for': 'compressFor', + 'default_in_memory': 'defaultInMemory', + 'default_in_memory_priority': 'defaultInMemoryPriority', + 'default_in_memory_distribute': 'defaultInMemoryDistribute', + 'default_in_memory_compression': 'defaultInMemoryCompression', + 'default_in_memory_duplicate': 'defaultInMemoryDuplicate', + 'shared': 'shared', + 'default_index_compression': 'defaultIndexCompression', + 'index_compress_for': 'indexCompressFor', + 'default_cell_memory': 'defaultCellMemory', + 'default_in_memory_service': 'defaultInMemoryService', + 'default_in_memory_service_name': 'defaultInMemoryServiceName', + 'lost_write_protect': 'lostWriteProtect', + 'is_chunk_tablespace': 'isChunkTablespace', + 'temp_group': 'tempGroup', + 'max_size_kb': 'maxSizeKB', + 'allocated_size_kb': 'allocatedSizeKB', + 'user_size_kb': 'userSizeKB', + 'free_space_kb': 'freeSpaceKB', + 'used_space_kb': 'usedSpaceKB', + 'used_percent_available': 'usedPercentAvailable', + 'used_percent_allocated': 'usedPercentAllocated', + 'datafiles': 'datafiles' + } + + self._name = None + self._type = None + self._status = None + self._block_size_bytes = None + self._logging = None + self._is_force_logging = None + self._extent_management = None + self._allocation_type = None + self._is_plugged_in = None + self._segment_space_management = None + self._default_table_compression = None + self._retention = None + self._is_bigfile = None + self._predicate_evaluation = None + self._is_encrypted = None + self._compress_for = None + self._default_in_memory = None + self._default_in_memory_priority = None + self._default_in_memory_distribute = None + self._default_in_memory_compression = None + self._default_in_memory_duplicate = None + self._shared = None + self._default_index_compression = None + self._index_compress_for = None + self._default_cell_memory = None + self._default_in_memory_service = None + self._default_in_memory_service_name = None + self._lost_write_protect = None + self._is_chunk_tablespace = None + self._temp_group = None + self._max_size_kb = None + self._allocated_size_kb = None + self._user_size_kb = None + self._free_space_kb = None + self._used_space_kb = None + self._used_percent_available = None + self._used_percent_allocated = None + self._datafiles = None + + @property + def name(self): + """ + **[Required]** Gets the name of this Tablespace. + The name of the tablespace. + + + :return: The name of this Tablespace. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Tablespace. + The name of the tablespace. + + + :param name: The name of this Tablespace. + :type: str + """ + self._name = name + + @property + def type(self): + """ + **[Required]** Gets the type of this Tablespace. + The type of the tablespace. + + Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY" + + + :return: The type of this Tablespace. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Tablespace. + The type of the tablespace. + + + :param type: The type of this Tablespace. + :type: str + """ + allowed_values = ["UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + "Invalid value for `type`, must be None or one of {0}" + .format(allowed_values) + ) + self._type = type + + @property + def status(self): + """ + Gets the status of this Tablespace. + The status of the tablespace. + + Allowed values for this property are: "ONLINE", "OFFLINE", "READ_ONLY" + + + :return: The status of this Tablespace. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this Tablespace. + The status of the tablespace. + + + :param status: The status of this Tablespace. + :type: str + """ + allowed_values = ["ONLINE", "OFFLINE", "READ_ONLY"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + raise ValueError( + "Invalid value for `status`, must be None or one of {0}" + .format(allowed_values) + ) + self._status = status + + @property + def block_size_bytes(self): + """ + Gets the block_size_bytes of this Tablespace. + The tablespace block size in bytes. + + + :return: The block_size_bytes of this Tablespace. + :rtype: float + """ + return self._block_size_bytes + + @block_size_bytes.setter + def block_size_bytes(self, block_size_bytes): + """ + Sets the block_size_bytes of this Tablespace. + The tablespace block size in bytes. + + + :param block_size_bytes: The block_size_bytes of this Tablespace. + :type: float + """ + self._block_size_bytes = block_size_bytes + + @property + def logging(self): + """ + Gets the logging of this Tablespace. + The default logging attribute. + + Allowed values for this property are: "LOGGING", "NOLOGGING" + + + :return: The logging of this Tablespace. + :rtype: str + """ + return self._logging + + @logging.setter + def logging(self, logging): + """ + Sets the logging of this Tablespace. + The default logging attribute. + + + :param logging: The logging of this Tablespace. + :type: str + """ + allowed_values = ["LOGGING", "NOLOGGING"] + if not value_allowed_none_or_none_sentinel(logging, allowed_values): + raise ValueError( + "Invalid value for `logging`, must be None or one of {0}" + .format(allowed_values) + ) + self._logging = logging + + @property + def is_force_logging(self): + """ + Gets the is_force_logging of this Tablespace. + Indicates whether the tablespace is under Force Logging mode. + + + :return: The is_force_logging of this Tablespace. + :rtype: bool + """ + return self._is_force_logging + + @is_force_logging.setter + def is_force_logging(self, is_force_logging): + """ + Sets the is_force_logging of this Tablespace. + Indicates whether the tablespace is under Force Logging mode. + + + :param is_force_logging: The is_force_logging of this Tablespace. + :type: bool + """ + self._is_force_logging = is_force_logging + + @property + def extent_management(self): + """ + Gets the extent_management of this Tablespace. + Indicates whether the extents in the tablespace are Locally managed or Dictionary managed. + + Allowed values for this property are: "LOCAL", "DICTIONARY" + + + :return: The extent_management of this Tablespace. + :rtype: str + """ + return self._extent_management + + @extent_management.setter + def extent_management(self, extent_management): + """ + Sets the extent_management of this Tablespace. + Indicates whether the extents in the tablespace are Locally managed or Dictionary managed. + + + :param extent_management: The extent_management of this Tablespace. + :type: str + """ + allowed_values = ["LOCAL", "DICTIONARY"] + if not value_allowed_none_or_none_sentinel(extent_management, allowed_values): + raise ValueError( + "Invalid value for `extent_management`, must be None or one of {0}" + .format(allowed_values) + ) + self._extent_management = extent_management + + @property + def allocation_type(self): + """ + Gets the allocation_type of this Tablespace. + The type of extent allocation in effect for the tablespace. + + Allowed values for this property are: "SYSTEM", "UNIFORM", "USER" + + + :return: The allocation_type of this Tablespace. + :rtype: str + """ + return self._allocation_type + + @allocation_type.setter + def allocation_type(self, allocation_type): + """ + Sets the allocation_type of this Tablespace. + The type of extent allocation in effect for the tablespace. + + + :param allocation_type: The allocation_type of this Tablespace. + :type: str + """ + allowed_values = ["SYSTEM", "UNIFORM", "USER"] + if not value_allowed_none_or_none_sentinel(allocation_type, allowed_values): + raise ValueError( + "Invalid value for `allocation_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._allocation_type = allocation_type + + @property + def is_plugged_in(self): + """ + Gets the is_plugged_in of this Tablespace. + Indicates whether the tablespace is plugged in. + + + :return: The is_plugged_in of this Tablespace. + :rtype: bool + """ + return self._is_plugged_in + + @is_plugged_in.setter + def is_plugged_in(self, is_plugged_in): + """ + Sets the is_plugged_in of this Tablespace. + Indicates whether the tablespace is plugged in. + + + :param is_plugged_in: The is_plugged_in of this Tablespace. + :type: bool + """ + self._is_plugged_in = is_plugged_in + + @property + def segment_space_management(self): + """ + Gets the segment_space_management of this Tablespace. + Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO). + + Allowed values for this property are: "MANUAL", "AUTO" + + + :return: The segment_space_management of this Tablespace. + :rtype: str + """ + return self._segment_space_management + + @segment_space_management.setter + def segment_space_management(self, segment_space_management): + """ + Sets the segment_space_management of this Tablespace. + Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO). + + + :param segment_space_management: The segment_space_management of this Tablespace. + :type: str + """ + allowed_values = ["MANUAL", "AUTO"] + if not value_allowed_none_or_none_sentinel(segment_space_management, allowed_values): + raise ValueError( + "Invalid value for `segment_space_management`, must be None or one of {0}" + .format(allowed_values) + ) + self._segment_space_management = segment_space_management + + @property + def default_table_compression(self): + """ + Gets the default_table_compression of this Tablespace. + Indicates whether default table compression is enabled or disabled. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The default_table_compression of this Tablespace. + :rtype: str + """ + return self._default_table_compression + + @default_table_compression.setter + def default_table_compression(self, default_table_compression): + """ + Sets the default_table_compression of this Tablespace. + Indicates whether default table compression is enabled or disabled. + + + :param default_table_compression: The default_table_compression of this Tablespace. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_table_compression, allowed_values): + raise ValueError( + "Invalid value for `default_table_compression`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_table_compression = default_table_compression + + @property + def retention(self): + """ + Gets the retention of this Tablespace. + Indicates whether undo retention guarantee is enabled for the tablespace. + + Allowed values for this property are: "GUARANTEE", "NOGUARANTEE", "NOT_APPLY" + + + :return: The retention of this Tablespace. + :rtype: str + """ + return self._retention + + @retention.setter + def retention(self, retention): + """ + Sets the retention of this Tablespace. + Indicates whether undo retention guarantee is enabled for the tablespace. + + + :param retention: The retention of this Tablespace. + :type: str + """ + allowed_values = ["GUARANTEE", "NOGUARANTEE", "NOT_APPLY"] + if not value_allowed_none_or_none_sentinel(retention, allowed_values): + raise ValueError( + "Invalid value for `retention`, must be None or one of {0}" + .format(allowed_values) + ) + self._retention = retention + + @property + def is_bigfile(self): + """ + Gets the is_bigfile of this Tablespace. + Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace. + + + :return: The is_bigfile of this Tablespace. + :rtype: bool + """ + return self._is_bigfile + + @is_bigfile.setter + def is_bigfile(self, is_bigfile): + """ + Sets the is_bigfile of this Tablespace. + Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace. + + + :param is_bigfile: The is_bigfile of this Tablespace. + :type: bool + """ + self._is_bigfile = is_bigfile + + @property + def predicate_evaluation(self): + """ + Gets the predicate_evaluation of this Tablespace. + Indicates whether predicates are evaluated by Host or by Storage. + + Allowed values for this property are: "HOST", "STORAGE" + + + :return: The predicate_evaluation of this Tablespace. + :rtype: str + """ + return self._predicate_evaluation + + @predicate_evaluation.setter + def predicate_evaluation(self, predicate_evaluation): + """ + Sets the predicate_evaluation of this Tablespace. + Indicates whether predicates are evaluated by Host or by Storage. + + + :param predicate_evaluation: The predicate_evaluation of this Tablespace. + :type: str + """ + allowed_values = ["HOST", "STORAGE"] + if not value_allowed_none_or_none_sentinel(predicate_evaluation, allowed_values): + raise ValueError( + "Invalid value for `predicate_evaluation`, must be None or one of {0}" + .format(allowed_values) + ) + self._predicate_evaluation = predicate_evaluation + + @property + def is_encrypted(self): + """ + Gets the is_encrypted of this Tablespace. + Indicates whether the tablespace is encrypted. + + + :return: The is_encrypted of this Tablespace. + :rtype: bool + """ + return self._is_encrypted + + @is_encrypted.setter + def is_encrypted(self, is_encrypted): + """ + Sets the is_encrypted of this Tablespace. + Indicates whether the tablespace is encrypted. + + + :param is_encrypted: The is_encrypted of this Tablespace. + :type: bool + """ + self._is_encrypted = is_encrypted + + @property + def compress_for(self): + """ + Gets the compress_for of this Tablespace. + The operation type for which default compression is enabled. + + Allowed values for this property are: "BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS" + + + :return: The compress_for of this Tablespace. + :rtype: str + """ + return self._compress_for + + @compress_for.setter + def compress_for(self, compress_for): + """ + Sets the compress_for of this Tablespace. + The operation type for which default compression is enabled. + + + :param compress_for: The compress_for of this Tablespace. + :type: str + """ + allowed_values = ["BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS"] + if not value_allowed_none_or_none_sentinel(compress_for, allowed_values): + raise ValueError( + "Invalid value for `compress_for`, must be None or one of {0}" + .format(allowed_values) + ) + self._compress_for = compress_for + + @property + def default_in_memory(self): + """ + Gets the default_in_memory of this Tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The default_in_memory of this Tablespace. + :rtype: str + """ + return self._default_in_memory + + @default_in_memory.setter + def default_in_memory(self, default_in_memory): + """ + Sets the default_in_memory of this Tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + + + :param default_in_memory: The default_in_memory of this Tablespace. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_in_memory, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory = default_in_memory + + @property + def default_in_memory_priority(self): + """ + Gets the default_in_memory_priority of this Tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + + Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE" + + + :return: The default_in_memory_priority of this Tablespace. + :rtype: str + """ + return self._default_in_memory_priority + + @default_in_memory_priority.setter + def default_in_memory_priority(self, default_in_memory_priority): + """ + Sets the default_in_memory_priority of this Tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + + + :param default_in_memory_priority: The default_in_memory_priority of this Tablespace. + :type: str + """ + allowed_values = ["LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE"] + if not value_allowed_none_or_none_sentinel(default_in_memory_priority, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory_priority`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory_priority = default_in_memory_priority + + @property + def default_in_memory_distribute(self): + """ + Gets the default_in_memory_distribute of this Tablespace. + Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + + Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION" + + + :return: The default_in_memory_distribute of this Tablespace. + :rtype: str + """ + return self._default_in_memory_distribute + + @default_in_memory_distribute.setter + def default_in_memory_distribute(self, default_in_memory_distribute): + """ + Sets the default_in_memory_distribute of this Tablespace. + Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + + + :param default_in_memory_distribute: The default_in_memory_distribute of this Tablespace. + :type: str + """ + allowed_values = ["AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION"] + if not value_allowed_none_or_none_sentinel(default_in_memory_distribute, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory_distribute`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory_distribute = default_in_memory_distribute + + @property + def default_in_memory_compression(self): + """ + Gets the default_in_memory_compression of this Tablespace. + Indicates the default compression level for the IM column store for this tablespace. + + Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH" + + + :return: The default_in_memory_compression of this Tablespace. + :rtype: str + """ + return self._default_in_memory_compression + + @default_in_memory_compression.setter + def default_in_memory_compression(self, default_in_memory_compression): + """ + Sets the default_in_memory_compression of this Tablespace. + Indicates the default compression level for the IM column store for this tablespace. + + + :param default_in_memory_compression: The default_in_memory_compression of this Tablespace. + :type: str + """ + allowed_values = ["NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH"] + if not value_allowed_none_or_none_sentinel(default_in_memory_compression, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory_compression`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory_compression = default_in_memory_compression + + @property + def default_in_memory_duplicate(self): + """ + Gets the default_in_memory_duplicate of this Tablespace. + Indicates the duplicate setting for the IM column store in an Oracle RAC environment. + + Allowed values for this property are: "NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL" + + + :return: The default_in_memory_duplicate of this Tablespace. + :rtype: str + """ + return self._default_in_memory_duplicate + + @default_in_memory_duplicate.setter + def default_in_memory_duplicate(self, default_in_memory_duplicate): + """ + Sets the default_in_memory_duplicate of this Tablespace. + Indicates the duplicate setting for the IM column store in an Oracle RAC environment. + + + :param default_in_memory_duplicate: The default_in_memory_duplicate of this Tablespace. + :type: str + """ + allowed_values = ["NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL"] + if not value_allowed_none_or_none_sentinel(default_in_memory_duplicate, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory_duplicate`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory_duplicate = default_in_memory_duplicate + + @property + def shared(self): + """ + Gets the shared of this Tablespace. + Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types. + + Allowed values for this property are: "SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL" + + + :return: The shared of this Tablespace. + :rtype: str + """ + return self._shared + + @shared.setter + def shared(self, shared): + """ + Sets the shared of this Tablespace. + Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types. + + + :param shared: The shared of this Tablespace. + :type: str + """ + allowed_values = ["SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL"] + if not value_allowed_none_or_none_sentinel(shared, allowed_values): + raise ValueError( + "Invalid value for `shared`, must be None or one of {0}" + .format(allowed_values) + ) + self._shared = shared + + @property + def default_index_compression(self): + """ + Gets the default_index_compression of this Tablespace. + Indicates whether default index compression is enabled or disabled. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The default_index_compression of this Tablespace. + :rtype: str + """ + return self._default_index_compression + + @default_index_compression.setter + def default_index_compression(self, default_index_compression): + """ + Sets the default_index_compression of this Tablespace. + Indicates whether default index compression is enabled or disabled. + + + :param default_index_compression: The default_index_compression of this Tablespace. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_index_compression, allowed_values): + raise ValueError( + "Invalid value for `default_index_compression`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_index_compression = default_index_compression + + @property + def index_compress_for(self): + """ + Gets the index_compress_for of this Tablespace. + The operation type for which default index compression is enabled. + + Allowed values for this property are: "ADVANCED_LOW", "ADVANCED_HIGH" + + + :return: The index_compress_for of this Tablespace. + :rtype: str + """ + return self._index_compress_for + + @index_compress_for.setter + def index_compress_for(self, index_compress_for): + """ + Sets the index_compress_for of this Tablespace. + The operation type for which default index compression is enabled. + + + :param index_compress_for: The index_compress_for of this Tablespace. + :type: str + """ + allowed_values = ["ADVANCED_LOW", "ADVANCED_HIGH"] + if not value_allowed_none_or_none_sentinel(index_compress_for, allowed_values): + raise ValueError( + "Invalid value for `index_compress_for`, must be None or one of {0}" + .format(allowed_values) + ) + self._index_compress_for = index_compress_for + + @property + def default_cell_memory(self): + """ + Gets the default_cell_memory of this Tablespace. + This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata. + + + :return: The default_cell_memory of this Tablespace. + :rtype: str + """ + return self._default_cell_memory + + @default_cell_memory.setter + def default_cell_memory(self, default_cell_memory): + """ + Sets the default_cell_memory of this Tablespace. + This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata. + + + :param default_cell_memory: The default_cell_memory of this Tablespace. + :type: str + """ + self._default_cell_memory = default_cell_memory + + @property + def default_in_memory_service(self): + """ + Gets the default_in_memory_service of this Tablespace. + Indicates how the IM column store is populated on various instances by default for this tablespace. + + Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED" + + + :return: The default_in_memory_service of this Tablespace. + :rtype: str + """ + return self._default_in_memory_service + + @default_in_memory_service.setter + def default_in_memory_service(self, default_in_memory_service): + """ + Sets the default_in_memory_service of this Tablespace. + Indicates how the IM column store is populated on various instances by default for this tablespace. + + + :param default_in_memory_service: The default_in_memory_service of this Tablespace. + :type: str + """ + allowed_values = ["DEFAULT", "NONE", "ALL", "USER_DEFINED"] + if not value_allowed_none_or_none_sentinel(default_in_memory_service, allowed_values): + raise ValueError( + "Invalid value for `default_in_memory_service`, must be None or one of {0}" + .format(allowed_values) + ) + self._default_in_memory_service = default_in_memory_service + + @property + def default_in_memory_service_name(self): + """ + Gets the default_in_memory_service_name of this Tablespace. + Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + + + :return: The default_in_memory_service_name of this Tablespace. + :rtype: str + """ + return self._default_in_memory_service_name + + @default_in_memory_service_name.setter + def default_in_memory_service_name(self, default_in_memory_service_name): + """ + Sets the default_in_memory_service_name of this Tablespace. + Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + + + :param default_in_memory_service_name: The default_in_memory_service_name of this Tablespace. + :type: str + """ + self._default_in_memory_service_name = default_in_memory_service_name + + @property + def lost_write_protect(self): + """ + Gets the lost_write_protect of this Tablespace. + The lost write protection setting for the tablespace. + + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND" + + + :return: The lost_write_protect of this Tablespace. + :rtype: str + """ + return self._lost_write_protect + + @lost_write_protect.setter + def lost_write_protect(self, lost_write_protect): + """ + Sets the lost_write_protect of this Tablespace. + The lost write protection setting for the tablespace. + + + :param lost_write_protect: The lost_write_protect of this Tablespace. + :type: str + """ + allowed_values = ["ENABLED", "PROTECT_OFF", "SUSPEND"] + if not value_allowed_none_or_none_sentinel(lost_write_protect, allowed_values): + raise ValueError( + "Invalid value for `lost_write_protect`, must be None or one of {0}" + .format(allowed_values) + ) + self._lost_write_protect = lost_write_protect + + @property + def is_chunk_tablespace(self): + """ + Gets the is_chunk_tablespace of this Tablespace. + Indicates whether this is a chunk tablespace. + + + :return: The is_chunk_tablespace of this Tablespace. + :rtype: bool + """ + return self._is_chunk_tablespace + + @is_chunk_tablespace.setter + def is_chunk_tablespace(self, is_chunk_tablespace): + """ + Sets the is_chunk_tablespace of this Tablespace. + Indicates whether this is a chunk tablespace. + + + :param is_chunk_tablespace: The is_chunk_tablespace of this Tablespace. + :type: bool + """ + self._is_chunk_tablespace = is_chunk_tablespace + + @property + def temp_group(self): + """ + Gets the temp_group of this Tablespace. + The temporary tablespace group. + + + :return: The temp_group of this Tablespace. + :rtype: str + """ + return self._temp_group + + @temp_group.setter + def temp_group(self, temp_group): + """ + Sets the temp_group of this Tablespace. + The temporary tablespace group. + + + :param temp_group: The temp_group of this Tablespace. + :type: str + """ + self._temp_group = temp_group + + @property + def max_size_kb(self): + """ + Gets the max_size_kb of this Tablespace. + The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + + + :return: The max_size_kb of this Tablespace. + :rtype: float + """ + return self._max_size_kb + + @max_size_kb.setter + def max_size_kb(self, max_size_kb): + """ + Sets the max_size_kb of this Tablespace. + The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + + + :param max_size_kb: The max_size_kb of this Tablespace. + :type: float + """ + self._max_size_kb = max_size_kb + + @property + def allocated_size_kb(self): + """ + Gets the allocated_size_kb of this Tablespace. + The allocated tablespace size in KB. + + + :return: The allocated_size_kb of this Tablespace. + :rtype: float + """ + return self._allocated_size_kb + + @allocated_size_kb.setter + def allocated_size_kb(self, allocated_size_kb): + """ + Sets the allocated_size_kb of this Tablespace. + The allocated tablespace size in KB. + + + :param allocated_size_kb: The allocated_size_kb of this Tablespace. + :type: float + """ + self._allocated_size_kb = allocated_size_kb + + @property + def user_size_kb(self): + """ + Gets the user_size_kb of this Tablespace. + The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata. + + + :return: The user_size_kb of this Tablespace. + :rtype: float + """ + return self._user_size_kb + + @user_size_kb.setter + def user_size_kb(self, user_size_kb): + """ + Sets the user_size_kb of this Tablespace. + The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata. + + + :param user_size_kb: The user_size_kb of this Tablespace. + :type: float + """ + self._user_size_kb = user_size_kb + + @property + def free_space_kb(self): + """ + Gets the free_space_kb of this Tablespace. + The free space available in this tablespace in KB. + + + :return: The free_space_kb of this Tablespace. + :rtype: float + """ + return self._free_space_kb + + @free_space_kb.setter + def free_space_kb(self, free_space_kb): + """ + Sets the free_space_kb of this Tablespace. + The free space available in this tablespace in KB. + + + :param free_space_kb: The free_space_kb of this Tablespace. + :type: float + """ + self._free_space_kb = free_space_kb + + @property + def used_space_kb(self): + """ + Gets the used_space_kb of this Tablespace. + The total space used by the tablespace in KB. + + + :return: The used_space_kb of this Tablespace. + :rtype: float + """ + return self._used_space_kb + + @used_space_kb.setter + def used_space_kb(self, used_space_kb): + """ + Sets the used_space_kb of this Tablespace. + The total space used by the tablespace in KB. + + + :param used_space_kb: The used_space_kb of this Tablespace. + :type: float + """ + self._used_space_kb = used_space_kb + + @property + def used_percent_available(self): + """ + Gets the used_percent_available of this Tablespace. + The percentage of used space out of the maximum available space in the tablespace. + + + :return: The used_percent_available of this Tablespace. + :rtype: float + """ + return self._used_percent_available + + @used_percent_available.setter + def used_percent_available(self, used_percent_available): + """ + Sets the used_percent_available of this Tablespace. + The percentage of used space out of the maximum available space in the tablespace. + + + :param used_percent_available: The used_percent_available of this Tablespace. + :type: float + """ + self._used_percent_available = used_percent_available + + @property + def used_percent_allocated(self): + """ + Gets the used_percent_allocated of this Tablespace. + The percentage of used space out of the total allocated space in the tablespace. + + + :return: The used_percent_allocated of this Tablespace. + :rtype: float + """ + return self._used_percent_allocated + + @used_percent_allocated.setter + def used_percent_allocated(self, used_percent_allocated): + """ + Sets the used_percent_allocated of this Tablespace. + The percentage of used space out of the total allocated space in the tablespace. + + + :param used_percent_allocated: The used_percent_allocated of this Tablespace. + :type: float + """ + self._used_percent_allocated = used_percent_allocated + + @property + def datafiles(self): + """ + Gets the datafiles of this Tablespace. + A list of the datafiles associated with the tablespace. + + + :return: The datafiles of this Tablespace. + :rtype: list[oci.database_management.models.Datafile] + """ + return self._datafiles + + @datafiles.setter + def datafiles(self, datafiles): + """ + Sets the datafiles of this Tablespace. + A list of the datafiles associated with the tablespace. + + + :param datafiles: The datafiles of this Tablespace. + :type: list[oci.database_management.models.Datafile] + """ + self._datafiles = datafiles + + 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/database_management/models/tablespace_collection.py b/src/oci/database_management/models/tablespace_collection.py new file mode 100644 index 0000000000..e0e017ce0c --- /dev/null +++ b/src/oci/database_management/models/tablespace_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TablespaceCollection(object): + """ + A collection of tablespaces for a specific database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TablespaceCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this TablespaceCollection. + :type items: list[oci.database_management.models.TablespaceSummary] + + """ + self.swagger_types = { + 'items': 'list[TablespaceSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TablespaceCollection. + An array of TablespaceSummary resources. + + + :return: The items of this TablespaceCollection. + :rtype: list[oci.database_management.models.TablespaceSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TablespaceCollection. + An array of TablespaceSummary resources. + + + :param items: The items of this TablespaceCollection. + :type: list[oci.database_management.models.TablespaceSummary] + """ + self._items = items + + 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/database_management/models/tablespace_summary.py b/src/oci/database_management/models/tablespace_summary.py new file mode 100644 index 0000000000..7b2973ea50 --- /dev/null +++ b/src/oci/database_management/models/tablespace_summary.py @@ -0,0 +1,1637 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TablespaceSummary(object): + """ + The summary of a tablespace. + """ + + #: A constant which can be used with the type property of a TablespaceSummary. + #: This constant has a value of "UNDO" + TYPE_UNDO = "UNDO" + + #: A constant which can be used with the type property of a TablespaceSummary. + #: This constant has a value of "LOST_WRITE_PROTECTION" + TYPE_LOST_WRITE_PROTECTION = "LOST_WRITE_PROTECTION" + + #: A constant which can be used with the type property of a TablespaceSummary. + #: This constant has a value of "PERMANENT" + TYPE_PERMANENT = "PERMANENT" + + #: A constant which can be used with the type property of a TablespaceSummary. + #: This constant has a value of "TEMPORARY" + TYPE_TEMPORARY = "TEMPORARY" + + #: A constant which can be used with the status property of a TablespaceSummary. + #: This constant has a value of "ONLINE" + STATUS_ONLINE = "ONLINE" + + #: A constant which can be used with the status property of a TablespaceSummary. + #: This constant has a value of "OFFLINE" + STATUS_OFFLINE = "OFFLINE" + + #: A constant which can be used with the status property of a TablespaceSummary. + #: This constant has a value of "READ_ONLY" + STATUS_READ_ONLY = "READ_ONLY" + + #: A constant which can be used with the logging property of a TablespaceSummary. + #: This constant has a value of "LOGGING" + LOGGING_LOGGING = "LOGGING" + + #: A constant which can be used with the logging property of a TablespaceSummary. + #: This constant has a value of "NOLOGGING" + LOGGING_NOLOGGING = "NOLOGGING" + + #: A constant which can be used with the extent_management property of a TablespaceSummary. + #: This constant has a value of "LOCAL" + EXTENT_MANAGEMENT_LOCAL = "LOCAL" + + #: A constant which can be used with the extent_management property of a TablespaceSummary. + #: This constant has a value of "DICTIONARY" + EXTENT_MANAGEMENT_DICTIONARY = "DICTIONARY" + + #: A constant which can be used with the allocation_type property of a TablespaceSummary. + #: This constant has a value of "SYSTEM" + ALLOCATION_TYPE_SYSTEM = "SYSTEM" + + #: A constant which can be used with the allocation_type property of a TablespaceSummary. + #: This constant has a value of "UNIFORM" + ALLOCATION_TYPE_UNIFORM = "UNIFORM" + + #: A constant which can be used with the allocation_type property of a TablespaceSummary. + #: This constant has a value of "USER" + ALLOCATION_TYPE_USER = "USER" + + #: A constant which can be used with the segment_space_management property of a TablespaceSummary. + #: This constant has a value of "MANUAL" + SEGMENT_SPACE_MANAGEMENT_MANUAL = "MANUAL" + + #: A constant which can be used with the segment_space_management property of a TablespaceSummary. + #: This constant has a value of "AUTO" + SEGMENT_SPACE_MANAGEMENT_AUTO = "AUTO" + + #: A constant which can be used with the default_table_compression property of a TablespaceSummary. + #: This constant has a value of "ENABLED" + DEFAULT_TABLE_COMPRESSION_ENABLED = "ENABLED" + + #: A constant which can be used with the default_table_compression property of a TablespaceSummary. + #: This constant has a value of "DISABLED" + DEFAULT_TABLE_COMPRESSION_DISABLED = "DISABLED" + + #: A constant which can be used with the retention property of a TablespaceSummary. + #: This constant has a value of "GUARANTEE" + RETENTION_GUARANTEE = "GUARANTEE" + + #: A constant which can be used with the retention property of a TablespaceSummary. + #: This constant has a value of "NOGUARANTEE" + RETENTION_NOGUARANTEE = "NOGUARANTEE" + + #: A constant which can be used with the retention property of a TablespaceSummary. + #: This constant has a value of "NOT_APPLY" + RETENTION_NOT_APPLY = "NOT_APPLY" + + #: A constant which can be used with the predicate_evaluation property of a TablespaceSummary. + #: This constant has a value of "HOST" + PREDICATE_EVALUATION_HOST = "HOST" + + #: A constant which can be used with the predicate_evaluation property of a TablespaceSummary. + #: This constant has a value of "STORAGE" + PREDICATE_EVALUATION_STORAGE = "STORAGE" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "BASIC" + COMPRESS_FOR_BASIC = "BASIC" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "ADVANCED" + COMPRESS_FOR_ADVANCED = "ADVANCED" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "QUERY_LOW" + COMPRESS_FOR_QUERY_LOW = "QUERY_LOW" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "QUERY_HIGH" + COMPRESS_FOR_QUERY_HIGH = "QUERY_HIGH" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "ARCHIVE_LOW" + COMPRESS_FOR_ARCHIVE_LOW = "ARCHIVE_LOW" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "ARCHIVE_HIGH" + COMPRESS_FOR_ARCHIVE_HIGH = "ARCHIVE_HIGH" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "DIRECT_LOAD_ONLY" + COMPRESS_FOR_DIRECT_LOAD_ONLY = "DIRECT_LOAD_ONLY" + + #: A constant which can be used with the compress_for property of a TablespaceSummary. + #: This constant has a value of "FOR_ALL_OPERATIONS" + COMPRESS_FOR_FOR_ALL_OPERATIONS = "FOR_ALL_OPERATIONS" + + #: A constant which can be used with the default_in_memory property of a TablespaceSummary. + #: This constant has a value of "ENABLED" + DEFAULT_IN_MEMORY_ENABLED = "ENABLED" + + #: A constant which can be used with the default_in_memory property of a TablespaceSummary. + #: This constant has a value of "DISABLED" + DEFAULT_IN_MEMORY_DISABLED = "DISABLED" + + #: A constant which can be used with the default_in_memory_priority property of a TablespaceSummary. + #: This constant has a value of "LOW" + DEFAULT_IN_MEMORY_PRIORITY_LOW = "LOW" + + #: A constant which can be used with the default_in_memory_priority property of a TablespaceSummary. + #: This constant has a value of "MEDIUM" + DEFAULT_IN_MEMORY_PRIORITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the default_in_memory_priority property of a TablespaceSummary. + #: This constant has a value of "HIGH" + DEFAULT_IN_MEMORY_PRIORITY_HIGH = "HIGH" + + #: A constant which can be used with the default_in_memory_priority property of a TablespaceSummary. + #: This constant has a value of "CRITICAL" + DEFAULT_IN_MEMORY_PRIORITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the default_in_memory_priority property of a TablespaceSummary. + #: This constant has a value of "NONE" + DEFAULT_IN_MEMORY_PRIORITY_NONE = "NONE" + + #: A constant which can be used with the default_in_memory_distribute property of a TablespaceSummary. + #: This constant has a value of "AUTO" + DEFAULT_IN_MEMORY_DISTRIBUTE_AUTO = "AUTO" + + #: A constant which can be used with the default_in_memory_distribute property of a TablespaceSummary. + #: This constant has a value of "BY_ROWID_RANGE" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_ROWID_RANGE = "BY_ROWID_RANGE" + + #: A constant which can be used with the default_in_memory_distribute property of a TablespaceSummary. + #: This constant has a value of "BY_PARTITION" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_PARTITION = "BY_PARTITION" + + #: A constant which can be used with the default_in_memory_distribute property of a TablespaceSummary. + #: This constant has a value of "BY_SUBPARTITION" + DEFAULT_IN_MEMORY_DISTRIBUTE_BY_SUBPARTITION = "BY_SUBPARTITION" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "NO_MEMCOMPRESS" + DEFAULT_IN_MEMORY_COMPRESSION_NO_MEMCOMPRESS = "NO_MEMCOMPRESS" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "FOR_DML" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_DML = "FOR_DML" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "FOR_QUERY_LOW" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_QUERY_LOW = "FOR_QUERY_LOW" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "FOR_QUERY_HIGH" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_QUERY_HIGH = "FOR_QUERY_HIGH" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "FOR_CAPACITY_LOW" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_CAPACITY_LOW = "FOR_CAPACITY_LOW" + + #: A constant which can be used with the default_in_memory_compression property of a TablespaceSummary. + #: This constant has a value of "FOR_CAPACITY_HIGH" + DEFAULT_IN_MEMORY_COMPRESSION_FOR_CAPACITY_HIGH = "FOR_CAPACITY_HIGH" + + #: A constant which can be used with the default_in_memory_duplicate property of a TablespaceSummary. + #: This constant has a value of "NO_DUPLICATE" + DEFAULT_IN_MEMORY_DUPLICATE_NO_DUPLICATE = "NO_DUPLICATE" + + #: A constant which can be used with the default_in_memory_duplicate property of a TablespaceSummary. + #: This constant has a value of "DUPLICATE" + DEFAULT_IN_MEMORY_DUPLICATE_DUPLICATE = "DUPLICATE" + + #: A constant which can be used with the default_in_memory_duplicate property of a TablespaceSummary. + #: This constant has a value of "DUPLICATE_ALL" + DEFAULT_IN_MEMORY_DUPLICATE_DUPLICATE_ALL = "DUPLICATE_ALL" + + #: A constant which can be used with the shared property of a TablespaceSummary. + #: This constant has a value of "SHARED" + SHARED_SHARED = "SHARED" + + #: A constant which can be used with the shared property of a TablespaceSummary. + #: This constant has a value of "LOCAL_ON_LEAF" + SHARED_LOCAL_ON_LEAF = "LOCAL_ON_LEAF" + + #: A constant which can be used with the shared property of a TablespaceSummary. + #: This constant has a value of "LOCAL_ON_ALL" + SHARED_LOCAL_ON_ALL = "LOCAL_ON_ALL" + + #: A constant which can be used with the default_index_compression property of a TablespaceSummary. + #: This constant has a value of "ENABLED" + DEFAULT_INDEX_COMPRESSION_ENABLED = "ENABLED" + + #: A constant which can be used with the default_index_compression property of a TablespaceSummary. + #: This constant has a value of "DISABLED" + DEFAULT_INDEX_COMPRESSION_DISABLED = "DISABLED" + + #: A constant which can be used with the index_compress_for property of a TablespaceSummary. + #: This constant has a value of "ADVANCED_LOW" + INDEX_COMPRESS_FOR_ADVANCED_LOW = "ADVANCED_LOW" + + #: A constant which can be used with the index_compress_for property of a TablespaceSummary. + #: This constant has a value of "ADVANCED_HIGH" + INDEX_COMPRESS_FOR_ADVANCED_HIGH = "ADVANCED_HIGH" + + #: A constant which can be used with the default_in_memory_service property of a TablespaceSummary. + #: This constant has a value of "DEFAULT" + DEFAULT_IN_MEMORY_SERVICE_DEFAULT = "DEFAULT" + + #: A constant which can be used with the default_in_memory_service property of a TablespaceSummary. + #: This constant has a value of "NONE" + DEFAULT_IN_MEMORY_SERVICE_NONE = "NONE" + + #: A constant which can be used with the default_in_memory_service property of a TablespaceSummary. + #: This constant has a value of "ALL" + DEFAULT_IN_MEMORY_SERVICE_ALL = "ALL" + + #: A constant which can be used with the default_in_memory_service property of a TablespaceSummary. + #: This constant has a value of "USER_DEFINED" + DEFAULT_IN_MEMORY_SERVICE_USER_DEFINED = "USER_DEFINED" + + #: A constant which can be used with the lost_write_protect property of a TablespaceSummary. + #: This constant has a value of "ENABLED" + LOST_WRITE_PROTECT_ENABLED = "ENABLED" + + #: A constant which can be used with the lost_write_protect property of a TablespaceSummary. + #: This constant has a value of "PROTECT_OFF" + LOST_WRITE_PROTECT_PROTECT_OFF = "PROTECT_OFF" + + #: A constant which can be used with the lost_write_protect property of a TablespaceSummary. + #: This constant has a value of "SUSPEND" + LOST_WRITE_PROTECT_SUSPEND = "SUSPEND" + + def __init__(self, **kwargs): + """ + Initializes a new TablespaceSummary 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 TablespaceSummary. + :type name: str + + :param type: + The value to assign to the type property of this TablespaceSummary. + Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param status: + The value to assign to the status property of this TablespaceSummary. + Allowed values for this property are: "ONLINE", "OFFLINE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param block_size_bytes: + The value to assign to the block_size_bytes property of this TablespaceSummary. + :type block_size_bytes: float + + :param logging: + The value to assign to the logging property of this TablespaceSummary. + Allowed values for this property are: "LOGGING", "NOLOGGING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type logging: str + + :param is_force_logging: + The value to assign to the is_force_logging property of this TablespaceSummary. + :type is_force_logging: bool + + :param extent_management: + The value to assign to the extent_management property of this TablespaceSummary. + Allowed values for this property are: "LOCAL", "DICTIONARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type extent_management: str + + :param allocation_type: + The value to assign to the allocation_type property of this TablespaceSummary. + Allowed values for this property are: "SYSTEM", "UNIFORM", "USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type allocation_type: str + + :param is_plugged_in: + The value to assign to the is_plugged_in property of this TablespaceSummary. + :type is_plugged_in: bool + + :param segment_space_management: + The value to assign to the segment_space_management property of this TablespaceSummary. + Allowed values for this property are: "MANUAL", "AUTO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type segment_space_management: str + + :param default_table_compression: + The value to assign to the default_table_compression property of this TablespaceSummary. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_table_compression: str + + :param retention: + The value to assign to the retention property of this TablespaceSummary. + Allowed values for this property are: "GUARANTEE", "NOGUARANTEE", "NOT_APPLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type retention: str + + :param is_bigfile: + The value to assign to the is_bigfile property of this TablespaceSummary. + :type is_bigfile: bool + + :param predicate_evaluation: + The value to assign to the predicate_evaluation property of this TablespaceSummary. + Allowed values for this property are: "HOST", "STORAGE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type predicate_evaluation: str + + :param is_encrypted: + The value to assign to the is_encrypted property of this TablespaceSummary. + :type is_encrypted: bool + + :param compress_for: + The value to assign to the compress_for property of this TablespaceSummary. + Allowed values for this property are: "BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type compress_for: str + + :param default_in_memory: + The value to assign to the default_in_memory property of this TablespaceSummary. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory: str + + :param default_in_memory_priority: + The value to assign to the default_in_memory_priority property of this TablespaceSummary. + Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory_priority: str + + :param default_in_memory_distribute: + The value to assign to the default_in_memory_distribute property of this TablespaceSummary. + Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory_distribute: str + + :param default_in_memory_compression: + The value to assign to the default_in_memory_compression property of this TablespaceSummary. + Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory_compression: str + + :param default_in_memory_duplicate: + The value to assign to the default_in_memory_duplicate property of this TablespaceSummary. + Allowed values for this property are: "NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory_duplicate: str + + :param shared: + The value to assign to the shared property of this TablespaceSummary. + Allowed values for this property are: "SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type shared: str + + :param default_index_compression: + The value to assign to the default_index_compression property of this TablespaceSummary. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_index_compression: str + + :param index_compress_for: + The value to assign to the index_compress_for property of this TablespaceSummary. + Allowed values for this property are: "ADVANCED_LOW", "ADVANCED_HIGH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type index_compress_for: str + + :param default_cell_memory: + The value to assign to the default_cell_memory property of this TablespaceSummary. + :type default_cell_memory: str + + :param default_in_memory_service: + The value to assign to the default_in_memory_service property of this TablespaceSummary. + Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_in_memory_service: str + + :param default_in_memory_service_name: + The value to assign to the default_in_memory_service_name property of this TablespaceSummary. + :type default_in_memory_service_name: str + + :param lost_write_protect: + The value to assign to the lost_write_protect property of this TablespaceSummary. + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lost_write_protect: str + + :param is_chunk_tablespace: + The value to assign to the is_chunk_tablespace property of this TablespaceSummary. + :type is_chunk_tablespace: bool + + :param temp_group: + The value to assign to the temp_group property of this TablespaceSummary. + :type temp_group: str + + :param max_size_kb: + The value to assign to the max_size_kb property of this TablespaceSummary. + :type max_size_kb: float + + :param allocated_size_kb: + The value to assign to the allocated_size_kb property of this TablespaceSummary. + :type allocated_size_kb: float + + :param user_size_kb: + The value to assign to the user_size_kb property of this TablespaceSummary. + :type user_size_kb: float + + :param free_space_kb: + The value to assign to the free_space_kb property of this TablespaceSummary. + :type free_space_kb: float + + :param used_space_kb: + The value to assign to the used_space_kb property of this TablespaceSummary. + :type used_space_kb: float + + :param used_percent_available: + The value to assign to the used_percent_available property of this TablespaceSummary. + :type used_percent_available: float + + :param used_percent_allocated: + The value to assign to the used_percent_allocated property of this TablespaceSummary. + :type used_percent_allocated: float + + :param datafiles: + The value to assign to the datafiles property of this TablespaceSummary. + :type datafiles: list[oci.database_management.models.Datafile] + + """ + self.swagger_types = { + 'name': 'str', + 'type': 'str', + 'status': 'str', + 'block_size_bytes': 'float', + 'logging': 'str', + 'is_force_logging': 'bool', + 'extent_management': 'str', + 'allocation_type': 'str', + 'is_plugged_in': 'bool', + 'segment_space_management': 'str', + 'default_table_compression': 'str', + 'retention': 'str', + 'is_bigfile': 'bool', + 'predicate_evaluation': 'str', + 'is_encrypted': 'bool', + 'compress_for': 'str', + 'default_in_memory': 'str', + 'default_in_memory_priority': 'str', + 'default_in_memory_distribute': 'str', + 'default_in_memory_compression': 'str', + 'default_in_memory_duplicate': 'str', + 'shared': 'str', + 'default_index_compression': 'str', + 'index_compress_for': 'str', + 'default_cell_memory': 'str', + 'default_in_memory_service': 'str', + 'default_in_memory_service_name': 'str', + 'lost_write_protect': 'str', + 'is_chunk_tablespace': 'bool', + 'temp_group': 'str', + 'max_size_kb': 'float', + 'allocated_size_kb': 'float', + 'user_size_kb': 'float', + 'free_space_kb': 'float', + 'used_space_kb': 'float', + 'used_percent_available': 'float', + 'used_percent_allocated': 'float', + 'datafiles': 'list[Datafile]' + } + + self.attribute_map = { + 'name': 'name', + 'type': 'type', + 'status': 'status', + 'block_size_bytes': 'blockSizeBytes', + 'logging': 'logging', + 'is_force_logging': 'isForceLogging', + 'extent_management': 'extentManagement', + 'allocation_type': 'allocationType', + 'is_plugged_in': 'isPluggedIn', + 'segment_space_management': 'segmentSpaceManagement', + 'default_table_compression': 'defaultTableCompression', + 'retention': 'retention', + 'is_bigfile': 'isBigfile', + 'predicate_evaluation': 'predicateEvaluation', + 'is_encrypted': 'isEncrypted', + 'compress_for': 'compressFor', + 'default_in_memory': 'defaultInMemory', + 'default_in_memory_priority': 'defaultInMemoryPriority', + 'default_in_memory_distribute': 'defaultInMemoryDistribute', + 'default_in_memory_compression': 'defaultInMemoryCompression', + 'default_in_memory_duplicate': 'defaultInMemoryDuplicate', + 'shared': 'shared', + 'default_index_compression': 'defaultIndexCompression', + 'index_compress_for': 'indexCompressFor', + 'default_cell_memory': 'defaultCellMemory', + 'default_in_memory_service': 'defaultInMemoryService', + 'default_in_memory_service_name': 'defaultInMemoryServiceName', + 'lost_write_protect': 'lostWriteProtect', + 'is_chunk_tablespace': 'isChunkTablespace', + 'temp_group': 'tempGroup', + 'max_size_kb': 'maxSizeKB', + 'allocated_size_kb': 'allocatedSizeKB', + 'user_size_kb': 'userSizeKB', + 'free_space_kb': 'freeSpaceKB', + 'used_space_kb': 'usedSpaceKB', + 'used_percent_available': 'usedPercentAvailable', + 'used_percent_allocated': 'usedPercentAllocated', + 'datafiles': 'datafiles' + } + + self._name = None + self._type = None + self._status = None + self._block_size_bytes = None + self._logging = None + self._is_force_logging = None + self._extent_management = None + self._allocation_type = None + self._is_plugged_in = None + self._segment_space_management = None + self._default_table_compression = None + self._retention = None + self._is_bigfile = None + self._predicate_evaluation = None + self._is_encrypted = None + self._compress_for = None + self._default_in_memory = None + self._default_in_memory_priority = None + self._default_in_memory_distribute = None + self._default_in_memory_compression = None + self._default_in_memory_duplicate = None + self._shared = None + self._default_index_compression = None + self._index_compress_for = None + self._default_cell_memory = None + self._default_in_memory_service = None + self._default_in_memory_service_name = None + self._lost_write_protect = None + self._is_chunk_tablespace = None + self._temp_group = None + self._max_size_kb = None + self._allocated_size_kb = None + self._user_size_kb = None + self._free_space_kb = None + self._used_space_kb = None + self._used_percent_available = None + self._used_percent_allocated = None + self._datafiles = None + + @property + def name(self): + """ + **[Required]** Gets the name of this TablespaceSummary. + The name of the tablespace. + + + :return: The name of this TablespaceSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TablespaceSummary. + The name of the tablespace. + + + :param name: The name of this TablespaceSummary. + :type: str + """ + self._name = name + + @property + def type(self): + """ + **[Required]** Gets the type of this TablespaceSummary. + The type of the tablespace. + + Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this TablespaceSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this TablespaceSummary. + The type of the tablespace. + + + :param type: The type of this TablespaceSummary. + :type: str + """ + allowed_values = ["UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def status(self): + """ + Gets the status of this TablespaceSummary. + The status of the tablespace. + + Allowed values for this property are: "ONLINE", "OFFLINE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this TablespaceSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this TablespaceSummary. + The status of the tablespace. + + + :param status: The status of this TablespaceSummary. + :type: str + """ + allowed_values = ["ONLINE", "OFFLINE", "READ_ONLY"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def block_size_bytes(self): + """ + Gets the block_size_bytes of this TablespaceSummary. + The tablespace block size in bytes. + + + :return: The block_size_bytes of this TablespaceSummary. + :rtype: float + """ + return self._block_size_bytes + + @block_size_bytes.setter + def block_size_bytes(self, block_size_bytes): + """ + Sets the block_size_bytes of this TablespaceSummary. + The tablespace block size in bytes. + + + :param block_size_bytes: The block_size_bytes of this TablespaceSummary. + :type: float + """ + self._block_size_bytes = block_size_bytes + + @property + def logging(self): + """ + Gets the logging of this TablespaceSummary. + The default logging attribute. + + Allowed values for this property are: "LOGGING", "NOLOGGING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The logging of this TablespaceSummary. + :rtype: str + """ + return self._logging + + @logging.setter + def logging(self, logging): + """ + Sets the logging of this TablespaceSummary. + The default logging attribute. + + + :param logging: The logging of this TablespaceSummary. + :type: str + """ + allowed_values = ["LOGGING", "NOLOGGING"] + if not value_allowed_none_or_none_sentinel(logging, allowed_values): + logging = 'UNKNOWN_ENUM_VALUE' + self._logging = logging + + @property + def is_force_logging(self): + """ + Gets the is_force_logging of this TablespaceSummary. + Indicates whether the tablespace is under Force Logging mode. + + + :return: The is_force_logging of this TablespaceSummary. + :rtype: bool + """ + return self._is_force_logging + + @is_force_logging.setter + def is_force_logging(self, is_force_logging): + """ + Sets the is_force_logging of this TablespaceSummary. + Indicates whether the tablespace is under Force Logging mode. + + + :param is_force_logging: The is_force_logging of this TablespaceSummary. + :type: bool + """ + self._is_force_logging = is_force_logging + + @property + def extent_management(self): + """ + Gets the extent_management of this TablespaceSummary. + Indicates whether the extents in the tablespace are Locally managed or Dictionary managed. + + Allowed values for this property are: "LOCAL", "DICTIONARY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The extent_management of this TablespaceSummary. + :rtype: str + """ + return self._extent_management + + @extent_management.setter + def extent_management(self, extent_management): + """ + Sets the extent_management of this TablespaceSummary. + Indicates whether the extents in the tablespace are Locally managed or Dictionary managed. + + + :param extent_management: The extent_management of this TablespaceSummary. + :type: str + """ + allowed_values = ["LOCAL", "DICTIONARY"] + if not value_allowed_none_or_none_sentinel(extent_management, allowed_values): + extent_management = 'UNKNOWN_ENUM_VALUE' + self._extent_management = extent_management + + @property + def allocation_type(self): + """ + Gets the allocation_type of this TablespaceSummary. + The type of extent allocation in effect for the tablespace. + + Allowed values for this property are: "SYSTEM", "UNIFORM", "USER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The allocation_type of this TablespaceSummary. + :rtype: str + """ + return self._allocation_type + + @allocation_type.setter + def allocation_type(self, allocation_type): + """ + Sets the allocation_type of this TablespaceSummary. + The type of extent allocation in effect for the tablespace. + + + :param allocation_type: The allocation_type of this TablespaceSummary. + :type: str + """ + allowed_values = ["SYSTEM", "UNIFORM", "USER"] + if not value_allowed_none_or_none_sentinel(allocation_type, allowed_values): + allocation_type = 'UNKNOWN_ENUM_VALUE' + self._allocation_type = allocation_type + + @property + def is_plugged_in(self): + """ + Gets the is_plugged_in of this TablespaceSummary. + Indicates whether the tablespace is plugged in. + + + :return: The is_plugged_in of this TablespaceSummary. + :rtype: bool + """ + return self._is_plugged_in + + @is_plugged_in.setter + def is_plugged_in(self, is_plugged_in): + """ + Sets the is_plugged_in of this TablespaceSummary. + Indicates whether the tablespace is plugged in. + + + :param is_plugged_in: The is_plugged_in of this TablespaceSummary. + :type: bool + """ + self._is_plugged_in = is_plugged_in + + @property + def segment_space_management(self): + """ + Gets the segment_space_management of this TablespaceSummary. + Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO). + + Allowed values for this property are: "MANUAL", "AUTO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The segment_space_management of this TablespaceSummary. + :rtype: str + """ + return self._segment_space_management + + @segment_space_management.setter + def segment_space_management(self, segment_space_management): + """ + Sets the segment_space_management of this TablespaceSummary. + Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO). + + + :param segment_space_management: The segment_space_management of this TablespaceSummary. + :type: str + """ + allowed_values = ["MANUAL", "AUTO"] + if not value_allowed_none_or_none_sentinel(segment_space_management, allowed_values): + segment_space_management = 'UNKNOWN_ENUM_VALUE' + self._segment_space_management = segment_space_management + + @property + def default_table_compression(self): + """ + Gets the default_table_compression of this TablespaceSummary. + Indicates whether default table compression is enabled or disabled. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_table_compression of this TablespaceSummary. + :rtype: str + """ + return self._default_table_compression + + @default_table_compression.setter + def default_table_compression(self, default_table_compression): + """ + Sets the default_table_compression of this TablespaceSummary. + Indicates whether default table compression is enabled or disabled. + + + :param default_table_compression: The default_table_compression of this TablespaceSummary. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_table_compression, allowed_values): + default_table_compression = 'UNKNOWN_ENUM_VALUE' + self._default_table_compression = default_table_compression + + @property + def retention(self): + """ + Gets the retention of this TablespaceSummary. + Indicates whether undo retention guarantee is enabled for the tablespace. + + Allowed values for this property are: "GUARANTEE", "NOGUARANTEE", "NOT_APPLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The retention of this TablespaceSummary. + :rtype: str + """ + return self._retention + + @retention.setter + def retention(self, retention): + """ + Sets the retention of this TablespaceSummary. + Indicates whether undo retention guarantee is enabled for the tablespace. + + + :param retention: The retention of this TablespaceSummary. + :type: str + """ + allowed_values = ["GUARANTEE", "NOGUARANTEE", "NOT_APPLY"] + if not value_allowed_none_or_none_sentinel(retention, allowed_values): + retention = 'UNKNOWN_ENUM_VALUE' + self._retention = retention + + @property + def is_bigfile(self): + """ + Gets the is_bigfile of this TablespaceSummary. + Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace. + + + :return: The is_bigfile of this TablespaceSummary. + :rtype: bool + """ + return self._is_bigfile + + @is_bigfile.setter + def is_bigfile(self, is_bigfile): + """ + Sets the is_bigfile of this TablespaceSummary. + Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace. + + + :param is_bigfile: The is_bigfile of this TablespaceSummary. + :type: bool + """ + self._is_bigfile = is_bigfile + + @property + def predicate_evaluation(self): + """ + Gets the predicate_evaluation of this TablespaceSummary. + Indicates whether predicates are evaluated by Host or by Storage. + + Allowed values for this property are: "HOST", "STORAGE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The predicate_evaluation of this TablespaceSummary. + :rtype: str + """ + return self._predicate_evaluation + + @predicate_evaluation.setter + def predicate_evaluation(self, predicate_evaluation): + """ + Sets the predicate_evaluation of this TablespaceSummary. + Indicates whether predicates are evaluated by Host or by Storage. + + + :param predicate_evaluation: The predicate_evaluation of this TablespaceSummary. + :type: str + """ + allowed_values = ["HOST", "STORAGE"] + if not value_allowed_none_or_none_sentinel(predicate_evaluation, allowed_values): + predicate_evaluation = 'UNKNOWN_ENUM_VALUE' + self._predicate_evaluation = predicate_evaluation + + @property + def is_encrypted(self): + """ + Gets the is_encrypted of this TablespaceSummary. + Indicates whether the tablespace is encrypted. + + + :return: The is_encrypted of this TablespaceSummary. + :rtype: bool + """ + return self._is_encrypted + + @is_encrypted.setter + def is_encrypted(self, is_encrypted): + """ + Sets the is_encrypted of this TablespaceSummary. + Indicates whether the tablespace is encrypted. + + + :param is_encrypted: The is_encrypted of this TablespaceSummary. + :type: bool + """ + self._is_encrypted = is_encrypted + + @property + def compress_for(self): + """ + Gets the compress_for of this TablespaceSummary. + The operation type for which default compression is enabled. + + Allowed values for this property are: "BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The compress_for of this TablespaceSummary. + :rtype: str + """ + return self._compress_for + + @compress_for.setter + def compress_for(self, compress_for): + """ + Sets the compress_for of this TablespaceSummary. + The operation type for which default compression is enabled. + + + :param compress_for: The compress_for of this TablespaceSummary. + :type: str + """ + allowed_values = ["BASIC", "ADVANCED", "QUERY_LOW", "QUERY_HIGH", "ARCHIVE_LOW", "ARCHIVE_HIGH", "DIRECT_LOAD_ONLY", "FOR_ALL_OPERATIONS"] + if not value_allowed_none_or_none_sentinel(compress_for, allowed_values): + compress_for = 'UNKNOWN_ENUM_VALUE' + self._compress_for = compress_for + + @property + def default_in_memory(self): + """ + Gets the default_in_memory of this TablespaceSummary. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory + + @default_in_memory.setter + def default_in_memory(self, default_in_memory): + """ + Sets the default_in_memory of this TablespaceSummary. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + + + :param default_in_memory: The default_in_memory of this TablespaceSummary. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_in_memory, allowed_values): + default_in_memory = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory = default_in_memory + + @property + def default_in_memory_priority(self): + """ + Gets the default_in_memory_priority of this TablespaceSummary. + Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + + Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory_priority of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_priority + + @default_in_memory_priority.setter + def default_in_memory_priority(self, default_in_memory_priority): + """ + Sets the default_in_memory_priority of this TablespaceSummary. + Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + + + :param default_in_memory_priority: The default_in_memory_priority of this TablespaceSummary. + :type: str + """ + allowed_values = ["LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE"] + if not value_allowed_none_or_none_sentinel(default_in_memory_priority, allowed_values): + default_in_memory_priority = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory_priority = default_in_memory_priority + + @property + def default_in_memory_distribute(self): + """ + Gets the default_in_memory_distribute of this TablespaceSummary. + Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + + Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory_distribute of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_distribute + + @default_in_memory_distribute.setter + def default_in_memory_distribute(self, default_in_memory_distribute): + """ + Sets the default_in_memory_distribute of this TablespaceSummary. + Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + + + :param default_in_memory_distribute: The default_in_memory_distribute of this TablespaceSummary. + :type: str + """ + allowed_values = ["AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION"] + if not value_allowed_none_or_none_sentinel(default_in_memory_distribute, allowed_values): + default_in_memory_distribute = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory_distribute = default_in_memory_distribute + + @property + def default_in_memory_compression(self): + """ + Gets the default_in_memory_compression of this TablespaceSummary. + Indicates the default compression level for the IM column store for this tablespace. + + Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory_compression of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_compression + + @default_in_memory_compression.setter + def default_in_memory_compression(self, default_in_memory_compression): + """ + Sets the default_in_memory_compression of this TablespaceSummary. + Indicates the default compression level for the IM column store for this tablespace. + + + :param default_in_memory_compression: The default_in_memory_compression of this TablespaceSummary. + :type: str + """ + allowed_values = ["NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH"] + if not value_allowed_none_or_none_sentinel(default_in_memory_compression, allowed_values): + default_in_memory_compression = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory_compression = default_in_memory_compression + + @property + def default_in_memory_duplicate(self): + """ + Gets the default_in_memory_duplicate of this TablespaceSummary. + Indicates the duplicate setting for the IM column store in an Oracle RAC environment. + + Allowed values for this property are: "NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory_duplicate of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_duplicate + + @default_in_memory_duplicate.setter + def default_in_memory_duplicate(self, default_in_memory_duplicate): + """ + Sets the default_in_memory_duplicate of this TablespaceSummary. + Indicates the duplicate setting for the IM column store in an Oracle RAC environment. + + + :param default_in_memory_duplicate: The default_in_memory_duplicate of this TablespaceSummary. + :type: str + """ + allowed_values = ["NO_DUPLICATE", "DUPLICATE", "DUPLICATE_ALL"] + if not value_allowed_none_or_none_sentinel(default_in_memory_duplicate, allowed_values): + default_in_memory_duplicate = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory_duplicate = default_in_memory_duplicate + + @property + def shared(self): + """ + Gets the shared of this TablespaceSummary. + Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types. + + Allowed values for this property are: "SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The shared of this TablespaceSummary. + :rtype: str + """ + return self._shared + + @shared.setter + def shared(self, shared): + """ + Sets the shared of this TablespaceSummary. + Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types. + + + :param shared: The shared of this TablespaceSummary. + :type: str + """ + allowed_values = ["SHARED", "LOCAL_ON_LEAF", "LOCAL_ON_ALL"] + if not value_allowed_none_or_none_sentinel(shared, allowed_values): + shared = 'UNKNOWN_ENUM_VALUE' + self._shared = shared + + @property + def default_index_compression(self): + """ + Gets the default_index_compression of this TablespaceSummary. + Indicates whether default index compression is enabled or disabled. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_index_compression of this TablespaceSummary. + :rtype: str + """ + return self._default_index_compression + + @default_index_compression.setter + def default_index_compression(self, default_index_compression): + """ + Sets the default_index_compression of this TablespaceSummary. + Indicates whether default index compression is enabled or disabled. + + + :param default_index_compression: The default_index_compression of this TablespaceSummary. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(default_index_compression, allowed_values): + default_index_compression = 'UNKNOWN_ENUM_VALUE' + self._default_index_compression = default_index_compression + + @property + def index_compress_for(self): + """ + Gets the index_compress_for of this TablespaceSummary. + The operation type for which default index compression is enabled. + + Allowed values for this property are: "ADVANCED_LOW", "ADVANCED_HIGH", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The index_compress_for of this TablespaceSummary. + :rtype: str + """ + return self._index_compress_for + + @index_compress_for.setter + def index_compress_for(self, index_compress_for): + """ + Sets the index_compress_for of this TablespaceSummary. + The operation type for which default index compression is enabled. + + + :param index_compress_for: The index_compress_for of this TablespaceSummary. + :type: str + """ + allowed_values = ["ADVANCED_LOW", "ADVANCED_HIGH"] + if not value_allowed_none_or_none_sentinel(index_compress_for, allowed_values): + index_compress_for = 'UNKNOWN_ENUM_VALUE' + self._index_compress_for = index_compress_for + + @property + def default_cell_memory(self): + """ + Gets the default_cell_memory of this TablespaceSummary. + This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata. + + + :return: The default_cell_memory of this TablespaceSummary. + :rtype: str + """ + return self._default_cell_memory + + @default_cell_memory.setter + def default_cell_memory(self, default_cell_memory): + """ + Sets the default_cell_memory of this TablespaceSummary. + This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata. + + + :param default_cell_memory: The default_cell_memory of this TablespaceSummary. + :type: str + """ + self._default_cell_memory = default_cell_memory + + @property + def default_in_memory_service(self): + """ + Gets the default_in_memory_service of this TablespaceSummary. + Indicates how the IM column store is populated on various instances by default for this tablespace. + + Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_in_memory_service of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_service + + @default_in_memory_service.setter + def default_in_memory_service(self, default_in_memory_service): + """ + Sets the default_in_memory_service of this TablespaceSummary. + Indicates how the IM column store is populated on various instances by default for this tablespace. + + + :param default_in_memory_service: The default_in_memory_service of this TablespaceSummary. + :type: str + """ + allowed_values = ["DEFAULT", "NONE", "ALL", "USER_DEFINED"] + if not value_allowed_none_or_none_sentinel(default_in_memory_service, allowed_values): + default_in_memory_service = 'UNKNOWN_ENUM_VALUE' + self._default_in_memory_service = default_in_memory_service + + @property + def default_in_memory_service_name(self): + """ + Gets the default_in_memory_service_name of this TablespaceSummary. + Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + + + :return: The default_in_memory_service_name of this TablespaceSummary. + :rtype: str + """ + return self._default_in_memory_service_name + + @default_in_memory_service_name.setter + def default_in_memory_service_name(self, default_in_memory_service_name): + """ + Sets the default_in_memory_service_name of this TablespaceSummary. + Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + + + :param default_in_memory_service_name: The default_in_memory_service_name of this TablespaceSummary. + :type: str + """ + self._default_in_memory_service_name = default_in_memory_service_name + + @property + def lost_write_protect(self): + """ + Gets the lost_write_protect of this TablespaceSummary. + The lost write protection setting for the tablespace. + + Allowed values for this property are: "ENABLED", "PROTECT_OFF", "SUSPEND", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lost_write_protect of this TablespaceSummary. + :rtype: str + """ + return self._lost_write_protect + + @lost_write_protect.setter + def lost_write_protect(self, lost_write_protect): + """ + Sets the lost_write_protect of this TablespaceSummary. + The lost write protection setting for the tablespace. + + + :param lost_write_protect: The lost_write_protect of this TablespaceSummary. + :type: str + """ + allowed_values = ["ENABLED", "PROTECT_OFF", "SUSPEND"] + if not value_allowed_none_or_none_sentinel(lost_write_protect, allowed_values): + lost_write_protect = 'UNKNOWN_ENUM_VALUE' + self._lost_write_protect = lost_write_protect + + @property + def is_chunk_tablespace(self): + """ + Gets the is_chunk_tablespace of this TablespaceSummary. + Indicates whether this is a chunk tablespace. + + + :return: The is_chunk_tablespace of this TablespaceSummary. + :rtype: bool + """ + return self._is_chunk_tablespace + + @is_chunk_tablespace.setter + def is_chunk_tablespace(self, is_chunk_tablespace): + """ + Sets the is_chunk_tablespace of this TablespaceSummary. + Indicates whether this is a chunk tablespace. + + + :param is_chunk_tablespace: The is_chunk_tablespace of this TablespaceSummary. + :type: bool + """ + self._is_chunk_tablespace = is_chunk_tablespace + + @property + def temp_group(self): + """ + Gets the temp_group of this TablespaceSummary. + The temporary tablespace group. + + + :return: The temp_group of this TablespaceSummary. + :rtype: str + """ + return self._temp_group + + @temp_group.setter + def temp_group(self, temp_group): + """ + Sets the temp_group of this TablespaceSummary. + The temporary tablespace group. + + + :param temp_group: The temp_group of this TablespaceSummary. + :type: str + """ + self._temp_group = temp_group + + @property + def max_size_kb(self): + """ + Gets the max_size_kb of this TablespaceSummary. + The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + + + :return: The max_size_kb of this TablespaceSummary. + :rtype: float + """ + return self._max_size_kb + + @max_size_kb.setter + def max_size_kb(self, max_size_kb): + """ + Sets the max_size_kb of this TablespaceSummary. + The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + + + :param max_size_kb: The max_size_kb of this TablespaceSummary. + :type: float + """ + self._max_size_kb = max_size_kb + + @property + def allocated_size_kb(self): + """ + Gets the allocated_size_kb of this TablespaceSummary. + The allocated tablespace size in KB. + + + :return: The allocated_size_kb of this TablespaceSummary. + :rtype: float + """ + return self._allocated_size_kb + + @allocated_size_kb.setter + def allocated_size_kb(self, allocated_size_kb): + """ + Sets the allocated_size_kb of this TablespaceSummary. + The allocated tablespace size in KB. + + + :param allocated_size_kb: The allocated_size_kb of this TablespaceSummary. + :type: float + """ + self._allocated_size_kb = allocated_size_kb + + @property + def user_size_kb(self): + """ + Gets the user_size_kb of this TablespaceSummary. + The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata. + + + :return: The user_size_kb of this TablespaceSummary. + :rtype: float + """ + return self._user_size_kb + + @user_size_kb.setter + def user_size_kb(self, user_size_kb): + """ + Sets the user_size_kb of this TablespaceSummary. + The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata. + + + :param user_size_kb: The user_size_kb of this TablespaceSummary. + :type: float + """ + self._user_size_kb = user_size_kb + + @property + def free_space_kb(self): + """ + Gets the free_space_kb of this TablespaceSummary. + The free space available in this tablespace in KB. + + + :return: The free_space_kb of this TablespaceSummary. + :rtype: float + """ + return self._free_space_kb + + @free_space_kb.setter + def free_space_kb(self, free_space_kb): + """ + Sets the free_space_kb of this TablespaceSummary. + The free space available in this tablespace in KB. + + + :param free_space_kb: The free_space_kb of this TablespaceSummary. + :type: float + """ + self._free_space_kb = free_space_kb + + @property + def used_space_kb(self): + """ + Gets the used_space_kb of this TablespaceSummary. + The total space used by the tablespace in KB. + + + :return: The used_space_kb of this TablespaceSummary. + :rtype: float + """ + return self._used_space_kb + + @used_space_kb.setter + def used_space_kb(self, used_space_kb): + """ + Sets the used_space_kb of this TablespaceSummary. + The total space used by the tablespace in KB. + + + :param used_space_kb: The used_space_kb of this TablespaceSummary. + :type: float + """ + self._used_space_kb = used_space_kb + + @property + def used_percent_available(self): + """ + Gets the used_percent_available of this TablespaceSummary. + The percentage of used space out of the maximum available space in the tablespace. + + + :return: The used_percent_available of this TablespaceSummary. + :rtype: float + """ + return self._used_percent_available + + @used_percent_available.setter + def used_percent_available(self, used_percent_available): + """ + Sets the used_percent_available of this TablespaceSummary. + The percentage of used space out of the maximum available space in the tablespace. + + + :param used_percent_available: The used_percent_available of this TablespaceSummary. + :type: float + """ + self._used_percent_available = used_percent_available + + @property + def used_percent_allocated(self): + """ + Gets the used_percent_allocated of this TablespaceSummary. + The percentage of used space out of the total allocated space in the tablespace. + + + :return: The used_percent_allocated of this TablespaceSummary. + :rtype: float + """ + return self._used_percent_allocated + + @used_percent_allocated.setter + def used_percent_allocated(self, used_percent_allocated): + """ + Sets the used_percent_allocated of this TablespaceSummary. + The percentage of used space out of the total allocated space in the tablespace. + + + :param used_percent_allocated: The used_percent_allocated of this TablespaceSummary. + :type: float + """ + self._used_percent_allocated = used_percent_allocated + + @property + def datafiles(self): + """ + Gets the datafiles of this TablespaceSummary. + A list of the datafiles associated with the tablespace. + + + :return: The datafiles of this TablespaceSummary. + :rtype: list[oci.database_management.models.Datafile] + """ + return self._datafiles + + @datafiles.setter + def datafiles(self, datafiles): + """ + Sets the datafiles of this TablespaceSummary. + A list of the datafiles associated with the tablespace. + + + :param datafiles: The datafiles of this TablespaceSummary. + :type: list[oci.database_management.models.Datafile] + """ + self._datafiles = datafiles + + 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/database_management/models/update_database_parameters_result.py b/src/oci/database_management/models/update_database_parameters_result.py new file mode 100644 index 0000000000..566a1982bc --- /dev/null +++ b/src/oci/database_management/models/update_database_parameters_result.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateDatabaseParametersResult(object): + """ + The results of database parameters' update. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateDatabaseParametersResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this UpdateDatabaseParametersResult. + :type status: dict(str, DatabaseParameterUpdateStatus) + + """ + self.swagger_types = { + 'status': 'dict(str, DatabaseParameterUpdateStatus)' + } + + self.attribute_map = { + 'status': 'status' + } + + self._status = None + + @property + def status(self): + """ + **[Required]** Gets the status of this UpdateDatabaseParametersResult. + A map with the parameter name as key and its update status as value. + + + :return: The status of this UpdateDatabaseParametersResult. + :rtype: dict(str, DatabaseParameterUpdateStatus) + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UpdateDatabaseParametersResult. + A map with the parameter name as key and its update status as value. + + + :param status: The status of this UpdateDatabaseParametersResult. + :type: dict(str, DatabaseParameterUpdateStatus) + """ + self._status = status + + 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 a9d7d60279..6afcbca0a7 100644 --- a/src/oci/key_management/kms_crypto_client.py +++ b/src/oci/key_management/kms_crypto_client.py @@ -350,8 +350,11 @@ def generate_data_encryption_key(self, generate_key_details, **kwargs): def sign(self, sign_data_details, **kwargs): """ - Creates a digital signature for a message or message digest by using the private key in an asymmetric key. - To verify the generated signature, you can use the Verify operation or use the public key in the same asymmetric key outside of KMS + Creates a digital signature for a message or message digest by using the private key of a public-private key pair, + also known as an asymmetric key. To verify the generated signature, you can use the `Verify`__ + operation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key. + + __ https://docs.cloud.oracle.com/api/#/en/key/latest/VerifiedData/Verify :param oci.key_management.models.SignDataDetails sign_data_details: (required) @@ -418,8 +421,11 @@ def sign(self, sign_data_details, **kwargs): def verify(self, verify_data_details, **kwargs): """ - Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key. - You can also verify the digital signature by using the public key in the asymmetric key outside of KMS + Verifies a digital signature that was generated by the `Sign`__ operation + by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the + digital signature outside of the service, you can do so by using the public key of the asymmetric key. + + __ https://docs.cloud.oracle.com/api/#/en/key/latest/SignedData/Sign :param oci.key_management.models.VerifyDataDetails verify_data_details: (required) diff --git a/src/oci/key_management/kms_management_client.py b/src/oci/key_management/kms_management_client.py index 8c3b4024f3..065200b767 100644 --- a/src/oci/key_management/kms_management_client.py +++ b/src/oci/key_management/kms_management_client.py @@ -1070,6 +1070,86 @@ def get_key_version(self, key_id, key_version_id, **kwargs): header_params=header_params, response_type="KeyVersion") + def get_replication_status(self, replication_id, **kwargs): + """ + When a vault has a replica, each operation on the vault or its resources, such as + keys, is replicated and has an associated replicationId. Replication status provides + details about whether the operation associated with the given replicationId has been + successfully applied across replicas. + + + :param str replication_id: (required) + replicationId associated with an operation on a resource + + :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.ReplicationStatusDetails` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_replication_status API. + """ + resource_path = "/20180608/replicaOperations/{replicationId}/status" + 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_replication_status got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "replicationId": replication_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="ReplicationStatusDetails") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ReplicationStatusDetails") + def get_wrapping_key(self, **kwargs): """ Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and @@ -1491,15 +1571,15 @@ def list_keys(self, compartment_id, **kwargs): Allowed values are: "HSM", "SOFTWARE" :param str algorithm: (optional) - The algorithm used by a key's key versions to encrypt or decrypt. Currently, only AES, RSA and ECDSA are supported. + The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms. Allowed values are: "AES", "RSA", "ECDSA" :param int length: (optional) - The length of the key in bytes, expressed as an integer. Values of 16, 24, 32 are supported. + The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32. :param str curve_id: (optional) - The curve Id of the keys in case of ECDSA keys + The curve ID of the keys. (This pertains only to ECDSA keys.) Allowed values are: "NIST_P256", "NIST_P384", "NIST_P521" @@ -2050,7 +2130,7 @@ def update_key(self, key_id, update_key_details, **kwargs): """ Updates the properties of a master encryption key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, - the key must in an ENABLED or CREATING state to be updated. + the key must be 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 diff --git a/src/oci/key_management/kms_vault_client.py b/src/oci/key_management/kms_vault_client.py index 492f82eae2..e3818f112d 100644 --- a/src/oci/key_management/kms_vault_client.py +++ b/src/oci/key_management/kms_vault_client.py @@ -495,6 +495,222 @@ def create_vault(self, create_vault_details, **kwargs): body=create_vault_details, response_type="Vault") + def create_vault_replica(self, vault_id, create_vault_replica_details, **kwargs): + """ + Creates a replica for the vault in another region in the same realm + + The API is a no-op if called for same region that a vault is already replicated to. + 409 if called on a vault that is already replicated to a different region. Users need to delete + existing replica first before calling it with a different region. + + 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) + The OCID of the vault. + + :param oci.key_management.models.CreateVaultReplicaDetails create_vault_replica_details: (required) + CreateVaultReplicaDetails + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_vault_replica API. + """ + resource_path = "/20180608/vaults/{vaultId}/actions/createReplica" + 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( + "create_vault_replica got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "vaultId": vault_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=create_vault_replica_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_vault_replica_details) + + def delete_vault_replica(self, vault_id, delete_vault_replica_details, **kwargs): + """ + Deletes a vault replica + + 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) + The OCID of the vault. + + :param oci.key_management.models.DeleteVaultReplicaDetails delete_vault_replica_details: (required) + DeleteVaultReplicaDetails + + :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 None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_vault_replica API. + """ + resource_path = "/20180608/vaults/{vaultId}/actions/deleteReplica" + 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( + "delete_vault_replica got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "vaultId": vault_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=delete_vault_replica_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=delete_vault_replica_details) + def get_vault(self, vault_id, **kwargs): """ Gets the specified vault's configuration information. @@ -654,6 +870,156 @@ def get_vault_usage(self, vault_id, **kwargs): header_params=header_params, response_type="VaultUsage") + def list_vault_replicas(self, vault_id, **kwargs): + """ + Lists the replicas for a vault + + 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) + The OCID of the vault. + + :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 int limit: (optional) + The maximum number of items to return in a paginated \"List\" call. + + :param str page: (optional) + The value of the `opc-next-page` response header + from the previous \"List\" call. + + :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 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` + is ascending. + + Allowed values are: "TIMECREATED", "DISPLAYNAME" + + :param str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + 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.key_management.models.VaultReplicaSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_vault_replicas API. + """ + resource_path = "/20180608/vaults/{vaultId}/actions/listReplicas" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "limit", + "page", + "opc_request_id", + "opc_retry_token", + "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_vault_replicas got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "vaultId": vault_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)) + + 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) + ) + + 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), + "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", + "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, + query_params=query_params, + header_params=header_params, + response_type="list[VaultReplicaSummary]") + 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[VaultReplicaSummary]") + def list_vaults(self, compartment_id, **kwargs): """ Lists the vaults in the specified compartment. diff --git a/src/oci/key_management/models/__init__.py b/src/oci/key_management/models/__init__.py index 897be3f1fd..0b8d1dfb39 100644 --- a/src/oci/key_management/models/__init__.py +++ b/src/oci/key_management/models/__init__.py @@ -13,8 +13,10 @@ from .change_vault_compartment_details import ChangeVaultCompartmentDetails from .create_key_details import CreateKeyDetails from .create_vault_details import CreateVaultDetails +from .create_vault_replica_details import CreateVaultReplicaDetails from .decrypt_data_details import DecryptDataDetails from .decrypted_data import DecryptedData +from .delete_vault_replica_details import DeleteVaultReplicaDetails from .encrypt_data_details import EncryptDataDetails from .encrypted_data import EncryptedData from .export_key_details import ExportKeyDetails @@ -24,10 +26,14 @@ from .import_key_details import ImportKeyDetails from .import_key_version_details import ImportKeyVersionDetails from .key import Key +from .key_replica_details import KeyReplicaDetails from .key_shape import KeyShape from .key_summary import KeySummary from .key_version import KeyVersion +from .key_version_replica_details import KeyVersionReplicaDetails from .key_version_summary import KeyVersionSummary +from .replica_details import ReplicaDetails +from .replication_status_details import ReplicationStatusDetails from .restore_key_from_object_store_details import RestoreKeyFromObjectStoreDetails from .restore_vault_from_object_store_details import RestoreVaultFromObjectStoreDetails from .schedule_key_deletion_details import ScheduleKeyDeletionDetails @@ -38,6 +44,8 @@ from .update_key_details import UpdateKeyDetails from .update_vault_details import UpdateVaultDetails from .vault import Vault +from .vault_replica_details import VaultReplicaDetails +from .vault_replica_summary import VaultReplicaSummary from .vault_summary import VaultSummary from .vault_usage import VaultUsage from .verified_data import VerifiedData @@ -56,8 +64,10 @@ "ChangeVaultCompartmentDetails": ChangeVaultCompartmentDetails, "CreateKeyDetails": CreateKeyDetails, "CreateVaultDetails": CreateVaultDetails, + "CreateVaultReplicaDetails": CreateVaultReplicaDetails, "DecryptDataDetails": DecryptDataDetails, "DecryptedData": DecryptedData, + "DeleteVaultReplicaDetails": DeleteVaultReplicaDetails, "EncryptDataDetails": EncryptDataDetails, "EncryptedData": EncryptedData, "ExportKeyDetails": ExportKeyDetails, @@ -67,10 +77,14 @@ "ImportKeyDetails": ImportKeyDetails, "ImportKeyVersionDetails": ImportKeyVersionDetails, "Key": Key, + "KeyReplicaDetails": KeyReplicaDetails, "KeyShape": KeyShape, "KeySummary": KeySummary, "KeyVersion": KeyVersion, + "KeyVersionReplicaDetails": KeyVersionReplicaDetails, "KeyVersionSummary": KeyVersionSummary, + "ReplicaDetails": ReplicaDetails, + "ReplicationStatusDetails": ReplicationStatusDetails, "RestoreKeyFromObjectStoreDetails": RestoreKeyFromObjectStoreDetails, "RestoreVaultFromObjectStoreDetails": RestoreVaultFromObjectStoreDetails, "ScheduleKeyDeletionDetails": ScheduleKeyDeletionDetails, @@ -81,6 +95,8 @@ "UpdateKeyDetails": UpdateKeyDetails, "UpdateVaultDetails": UpdateVaultDetails, "Vault": Vault, + "VaultReplicaDetails": VaultReplicaDetails, + "VaultReplicaSummary": VaultReplicaSummary, "VaultSummary": VaultSummary, "VaultUsage": VaultUsage, "VerifiedData": VerifiedData, diff --git a/src/oci/key_management/models/create_vault_replica_details.py b/src/oci/key_management/models/create_vault_replica_details.py new file mode 100644 index 0000000000..c75f9551be --- /dev/null +++ b/src/oci/key_management/models/create_vault_replica_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateVaultReplicaDetails(object): + """ + Creates a vault replica. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateVaultReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replica_region: + The value to assign to the replica_region property of this CreateVaultReplicaDetails. + :type replica_region: str + + """ + self.swagger_types = { + 'replica_region': 'str' + } + + self.attribute_map = { + 'replica_region': 'replicaRegion' + } + + self._replica_region = None + + @property + def replica_region(self): + """ + **[Required]** Gets the replica_region of this CreateVaultReplicaDetails. + The region in the realm to which the vault need to be replicated to + + + :return: The replica_region of this CreateVaultReplicaDetails. + :rtype: str + """ + return self._replica_region + + @replica_region.setter + def replica_region(self, replica_region): + """ + Sets the replica_region of this CreateVaultReplicaDetails. + The region in the realm to which the vault need to be replicated to + + + :param replica_region: The replica_region of this CreateVaultReplicaDetails. + :type: str + """ + self._replica_region = replica_region + + 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/decrypt_data_details.py b/src/oci/key_management/models/decrypt_data_details.py index f4ecb119d2..fbe9e268fa 100644 --- a/src/oci/key_management/models/decrypt_data_details.py +++ b/src/oci/key_management/models/decrypt_data_details.py @@ -185,7 +185,7 @@ def logging_context(self, logging_context): def key_version_id(self): """ Gets the key_version_id of this DecryptDataDetails. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :return: The key_version_id of this DecryptDataDetails. @@ -197,7 +197,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this DecryptDataDetails. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :param key_version_id: The key_version_id of this DecryptDataDetails. @@ -209,9 +209,12 @@ def key_version_id(self, key_version_id): def encryption_algorithm(self): """ Gets the encryption_algorithm of this DecryptDataDetails. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt or decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" @@ -225,9 +228,12 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this DecryptDataDetails. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt or decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. :param encryption_algorithm: The encryption_algorithm of this DecryptDataDetails. diff --git a/src/oci/key_management/models/decrypted_data.py b/src/oci/key_management/models/decrypted_data.py index 56ed5d6bc5..69cb11af0a 100644 --- a/src/oci/key_management/models/decrypted_data.py +++ b/src/oci/key_management/models/decrypted_data.py @@ -103,7 +103,7 @@ def plaintext(self, plaintext): def plaintext_checksum(self): """ **[Required]** Gets the plaintext_checksum of this DecryptedData. - Checksum of the decrypted data. + The checksum of the decrypted data. :return: The plaintext_checksum of this DecryptedData. @@ -115,7 +115,7 @@ def plaintext_checksum(self): def plaintext_checksum(self, plaintext_checksum): """ Sets the plaintext_checksum of this DecryptedData. - Checksum of the decrypted data. + The checksum of the decrypted data. :param plaintext_checksum: The plaintext_checksum of this DecryptedData. @@ -151,7 +151,7 @@ def key_id(self, key_id): def key_version_id(self): """ Gets the key_version_id of this DecryptedData. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :return: The key_version_id of this DecryptedData. @@ -163,7 +163,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this DecryptedData. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :param key_version_id: The key_version_id of this DecryptedData. @@ -175,9 +175,12 @@ def key_version_id(self, key_version_id): def encryption_algorithm(self): """ Gets the encryption_algorithm of this DecryptedData. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -192,9 +195,12 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this DecryptedData. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. :param encryption_algorithm: The encryption_algorithm of this DecryptedData. diff --git a/src/oci/key_management/models/delete_vault_replica_details.py b/src/oci/key_management/models/delete_vault_replica_details.py new file mode 100644 index 0000000000..d2b69b5221 --- /dev/null +++ b/src/oci/key_management/models/delete_vault_replica_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DeleteVaultReplicaDetails(object): + """ + Deletes a vault replica + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeleteVaultReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replica_region: + The value to assign to the replica_region property of this DeleteVaultReplicaDetails. + :type replica_region: str + + """ + self.swagger_types = { + 'replica_region': 'str' + } + + self.attribute_map = { + 'replica_region': 'replicaRegion' + } + + self._replica_region = None + + @property + def replica_region(self): + """ + **[Required]** Gets the replica_region of this DeleteVaultReplicaDetails. + The region in the realm on which the replica should be deleted + + + :return: The replica_region of this DeleteVaultReplicaDetails. + :rtype: str + """ + return self._replica_region + + @replica_region.setter + def replica_region(self, replica_region): + """ + Sets the replica_region of this DeleteVaultReplicaDetails. + The region in the realm on which the replica should be deleted + + + :param replica_region: The replica_region of this DeleteVaultReplicaDetails. + :type: str + """ + self._replica_region = replica_region + + 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/encrypt_data_details.py b/src/oci/key_management/models/encrypt_data_details.py index deb8a9eb93..a1b2a588d7 100644 --- a/src/oci/key_management/models/encrypt_data_details.py +++ b/src/oci/key_management/models/encrypt_data_details.py @@ -187,7 +187,7 @@ def plaintext(self, plaintext): def key_version_id(self): """ Gets the key_version_id of this EncryptDataDetails. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :return: The key_version_id of this EncryptDataDetails. @@ -199,7 +199,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this EncryptDataDetails. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :param key_version_id: The key_version_id of this EncryptDataDetails. @@ -211,9 +211,12 @@ def key_version_id(self, key_version_id): def encryption_algorithm(self): """ Gets the encryption_algorithm of this EncryptDataDetails. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" @@ -227,9 +230,12 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this EncryptDataDetails. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. :param encryption_algorithm: The encryption_algorithm of this EncryptDataDetails. diff --git a/src/oci/key_management/models/encrypted_data.py b/src/oci/key_management/models/encrypted_data.py index cc44a18ede..98886ac813 100644 --- a/src/oci/key_management/models/encrypted_data.py +++ b/src/oci/key_management/models/encrypted_data.py @@ -96,7 +96,7 @@ def ciphertext(self, ciphertext): def key_id(self): """ Gets the key_id of this EncryptedData. - The OCID of the key used to sign the message + The OCID of the key used to encrypt the ciphertext. :return: The key_id of this EncryptedData. @@ -108,7 +108,7 @@ def key_id(self): def key_id(self, key_id): """ Sets the key_id of this EncryptedData. - The OCID of the key used to sign the message + The OCID of the key used to encrypt the ciphertext. :param key_id: The key_id of this EncryptedData. @@ -120,7 +120,7 @@ def key_id(self, key_id): def key_version_id(self): """ Gets the key_version_id of this EncryptedData. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :return: The key_version_id of this EncryptedData. @@ -132,7 +132,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this EncryptedData. - The OCID of the keyVersion used to encrypt the ciphertext. + The OCID of the key version used to encrypt the ciphertext. :param key_version_id: The key_version_id of this EncryptedData. @@ -144,9 +144,12 @@ def key_version_id(self, key_version_id): def encryption_algorithm(self): """ Gets the encryption_algorithm of this EncryptedData. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -161,9 +164,12 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this EncryptedData. - Encryption algorithm to be used while encrypting/decrypting data using a customer key - AES_256_GCM is the supported value AES keys and uses GCM mode of operation - RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. :param encryption_algorithm: The encryption_algorithm of this EncryptedData. diff --git a/src/oci/key_management/models/key.py b/src/oci/key_management/models/key.py index 826587c7e9..1d5501a8d2 100644 --- a/src/oci/key_management/models/key.py +++ b/src/oci/key_management/models/key.py @@ -134,6 +134,14 @@ def __init__(self, **kwargs): The value to assign to the restored_from_key_id property of this Key. :type restored_from_key_id: str + :param replica_details: + The value to assign to the replica_details property of this Key. + :type replica_details: oci.key_management.models.KeyReplicaDetails + + :param is_primary: + The value to assign to the is_primary property of this Key. + :type is_primary: bool + """ self.swagger_types = { 'compartment_id': 'str', @@ -148,7 +156,9 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_of_deletion': 'datetime', 'vault_id': 'str', - 'restored_from_key_id': 'str' + 'restored_from_key_id': 'str', + 'replica_details': 'KeyReplicaDetails', + 'is_primary': 'bool' } self.attribute_map = { @@ -164,7 +174,9 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_of_deletion': 'timeOfDeletion', 'vault_id': 'vaultId', - 'restored_from_key_id': 'restoredFromKeyId' + 'restored_from_key_id': 'restoredFromKeyId', + 'replica_details': 'replicaDetails', + 'is_primary': 'isPrimary' } self._compartment_id = None @@ -180,6 +192,8 @@ def __init__(self, **kwargs): self._time_of_deletion = None self._vault_id = None self._restored_from_key_id = None + self._replica_details = None + self._is_primary = None @property def compartment_id(self): @@ -549,6 +563,46 @@ def restored_from_key_id(self, restored_from_key_id): """ self._restored_from_key_id = restored_from_key_id + @property + def replica_details(self): + """ + Gets the replica_details of this Key. + + :return: The replica_details of this Key. + :rtype: oci.key_management.models.KeyReplicaDetails + """ + return self._replica_details + + @replica_details.setter + def replica_details(self, replica_details): + """ + Sets the replica_details of this Key. + + :param replica_details: The replica_details of this Key. + :type: oci.key_management.models.KeyReplicaDetails + """ + self._replica_details = replica_details + + @property + def is_primary(self): + """ + Gets the is_primary of this Key. + + :return: The is_primary of this Key. + :rtype: bool + """ + return self._is_primary + + @is_primary.setter + def is_primary(self, is_primary): + """ + Sets the is_primary of this Key. + + :param is_primary: The is_primary of this Key. + :type: bool + """ + self._is_primary = is_primary + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/key_replica_details.py b/src/oci/key_management/models/key_replica_details.py new file mode 100644 index 0000000000..50524ab6a2 --- /dev/null +++ b/src/oci/key_management/models/key_replica_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KeyReplicaDetails(object): + """ + Key replica details + """ + + def __init__(self, **kwargs): + """ + Initializes a new KeyReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replication_id: + The value to assign to the replication_id property of this KeyReplicaDetails. + :type replication_id: str + + """ + self.swagger_types = { + 'replication_id': 'str' + } + + self.attribute_map = { + 'replication_id': 'replicationId' + } + + self._replication_id = None + + @property + def replication_id(self): + """ + Gets the replication_id of this KeyReplicaDetails. + ReplicationId associated with a key operation + + + :return: The replication_id of this KeyReplicaDetails. + :rtype: str + """ + return self._replication_id + + @replication_id.setter + def replication_id(self, replication_id): + """ + Sets the replication_id of this KeyReplicaDetails. + ReplicationId associated with a key operation + + + :param replication_id: The replication_id of this KeyReplicaDetails. + :type: str + """ + self._replication_id = replication_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/key_management/models/key_shape.py b/src/oci/key_management/models/key_shape.py index 01f26c10b6..f8f11750bb 100644 --- a/src/oci/key_management/models/key_shape.py +++ b/src/oci/key_management/models/key_shape.py @@ -109,10 +109,10 @@ def algorithm(self, algorithm): def length(self): """ **[Required]** Gets the length of this KeyShape. - The length of the key in bytes, expressed as an integer. Values supported: - - AES: 16, 24 or 32 - - RSA: 256, 384 or 512 - - ECDSA: 32, 48, 66 + The length of the key in bytes, expressed as an integer. Supported values include the following: + - AES: 16, 24, or 32 + - RSA: 256, 384, or 512 + - ECDSA: 32, 48, or 66 :return: The length of this KeyShape. @@ -124,10 +124,10 @@ def length(self): def length(self, length): """ Sets the length of this KeyShape. - The length of the key in bytes, expressed as an integer. Values supported: - - AES: 16, 24 or 32 - - RSA: 256, 384 or 512 - - ECDSA: 32, 48, 66 + The length of the key in bytes, expressed as an integer. Supported values include the following: + - AES: 16, 24, or 32 + - RSA: 256, 384, or 512 + - ECDSA: 32, 48, or 66 :param length: The length of this KeyShape. @@ -139,7 +139,7 @@ def length(self, length): def curve_id(self): """ Gets the curve_id of this KeyShape. - Supported curve Ids for ECDSA keys + Supported curve IDs for ECDSA keys. Allowed values for this property are: "NIST_P256", "NIST_P384", "NIST_P521", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -154,7 +154,7 @@ def curve_id(self): def curve_id(self, curve_id): """ Sets the curve_id of this KeyShape. - Supported curve Ids for ECDSA keys + Supported curve IDs for ECDSA keys. :param curve_id: The curve_id of this KeyShape. diff --git a/src/oci/key_management/models/key_summary.py b/src/oci/key_management/models/key_summary.py index 39bf7e56c0..7ef77ea6f3 100644 --- a/src/oci/key_management/models/key_summary.py +++ b/src/oci/key_management/models/key_summary.py @@ -444,7 +444,7 @@ def protection_mode(self, protection_mode): def algorithm(self): """ Gets the algorithm of this KeySummary. - The algorithm used by a key's key versions to encrypt or decrypt. + The algorithm used by a key's key versions to encrypt or decrypt data. Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -459,7 +459,7 @@ def algorithm(self): def algorithm(self, algorithm): """ Sets the algorithm of this KeySummary. - The algorithm used by a key's key versions to encrypt or decrypt. + The algorithm used by a key's key versions to encrypt or decrypt data. :param algorithm: The algorithm of this KeySummary. diff --git a/src/oci/key_management/models/key_version.py b/src/oci/key_management/models/key_version.py index 660c00125f..443a72d234 100644 --- a/src/oci/key_management/models/key_version.py +++ b/src/oci/key_management/models/key_version.py @@ -110,6 +110,14 @@ def __init__(self, **kwargs): The value to assign to the restored_from_key_version_id property of this KeyVersion. :type restored_from_key_version_id: str + :param replica_details: + The value to assign to the replica_details property of this KeyVersion. + :type replica_details: oci.key_management.models.KeyVersionReplicaDetails + + :param is_primary: + The value to assign to the is_primary property of this KeyVersion. + :type is_primary: bool + """ self.swagger_types = { 'compartment_id': 'str', @@ -121,7 +129,9 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_of_deletion': 'datetime', 'vault_id': 'str', - 'restored_from_key_version_id': 'str' + 'restored_from_key_version_id': 'str', + 'replica_details': 'KeyVersionReplicaDetails', + 'is_primary': 'bool' } self.attribute_map = { @@ -134,7 +144,9 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_of_deletion': 'timeOfDeletion', 'vault_id': 'vaultId', - 'restored_from_key_version_id': 'restoredFromKeyVersionId' + 'restored_from_key_version_id': 'restoredFromKeyVersionId', + 'replica_details': 'replicaDetails', + 'is_primary': 'isPrimary' } self._compartment_id = None @@ -147,6 +159,8 @@ def __init__(self, **kwargs): self._time_of_deletion = None self._vault_id = None self._restored_from_key_version_id = None + self._replica_details = None + self._is_primary = None @property def compartment_id(self): @@ -224,7 +238,7 @@ def key_id(self, key_id): def public_key(self): """ Gets the public_key of this KeyVersion. - The public key in PEM format which will be populated only in case of RSA and ECDSA keys. + The public key in PEM format. (This value pertains only to RSA and ECDSA keys.) :return: The public_key of this KeyVersion. @@ -236,7 +250,7 @@ def public_key(self): def public_key(self, public_key): """ Sets the public_key of this KeyVersion. - The public key in PEM format which will be populated only in case of RSA and ECDSA keys. + The public key in PEM format. (This value pertains only to RSA and ECDSA keys.) :param public_key: The public_key of this KeyVersion. @@ -422,6 +436,46 @@ def restored_from_key_version_id(self, restored_from_key_version_id): """ self._restored_from_key_version_id = restored_from_key_version_id + @property + def replica_details(self): + """ + Gets the replica_details of this KeyVersion. + + :return: The replica_details of this KeyVersion. + :rtype: oci.key_management.models.KeyVersionReplicaDetails + """ + return self._replica_details + + @replica_details.setter + def replica_details(self, replica_details): + """ + Sets the replica_details of this KeyVersion. + + :param replica_details: The replica_details of this KeyVersion. + :type: oci.key_management.models.KeyVersionReplicaDetails + """ + self._replica_details = replica_details + + @property + def is_primary(self): + """ + Gets the is_primary of this KeyVersion. + + :return: The is_primary of this KeyVersion. + :rtype: bool + """ + return self._is_primary + + @is_primary.setter + def is_primary(self, is_primary): + """ + Sets the is_primary of this KeyVersion. + + :param is_primary: The is_primary of this KeyVersion. + :type: bool + """ + self._is_primary = is_primary + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/key_version_replica_details.py b/src/oci/key_management/models/key_version_replica_details.py new file mode 100644 index 0000000000..d5cc43ad4a --- /dev/null +++ b/src/oci/key_management/models/key_version_replica_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KeyVersionReplicaDetails(object): + """ + KeyVersion replica details + """ + + def __init__(self, **kwargs): + """ + Initializes a new KeyVersionReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replication_id: + The value to assign to the replication_id property of this KeyVersionReplicaDetails. + :type replication_id: str + + """ + self.swagger_types = { + 'replication_id': 'str' + } + + self.attribute_map = { + 'replication_id': 'replicationId' + } + + self._replication_id = None + + @property + def replication_id(self): + """ + Gets the replication_id of this KeyVersionReplicaDetails. + ReplicationId associated with a key version operation + + + :return: The replication_id of this KeyVersionReplicaDetails. + :rtype: str + """ + return self._replication_id + + @replication_id.setter + def replication_id(self, replication_id): + """ + Sets the replication_id of this KeyVersionReplicaDetails. + ReplicationId associated with a key version operation + + + :param replication_id: The replication_id of this KeyVersionReplicaDetails. + :type: str + """ + self._replication_id = replication_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/key_management/models/replica_details.py b/src/oci/key_management/models/replica_details.py new file mode 100644 index 0000000000..8cf04648c4 --- /dev/null +++ b/src/oci/key_management/models/replica_details.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReplicaDetails(object): + """ + Details of replication status + """ + + #: A constant which can be used with the status property of a ReplicaDetails. + #: This constant has a value of "REPLICATING" + STATUS_REPLICATING = "REPLICATING" + + #: A constant which can be used with the status property of a ReplicaDetails. + #: This constant has a value of "REPLICATED" + STATUS_REPLICATED = "REPLICATED" + + def __init__(self, **kwargs): + """ + Initializes a new ReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param region: + The value to assign to the region property of this ReplicaDetails. + :type region: str + + :param status: + The value to assign to the status property of this ReplicaDetails. + Allowed values for this property are: "REPLICATING", "REPLICATED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + """ + self.swagger_types = { + 'region': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'region': 'region', + 'status': 'status' + } + + self._region = None + self._status = None + + @property + def region(self): + """ + Gets the region of this ReplicaDetails. + The replica region + + + :return: The region of this ReplicaDetails. + :rtype: str + """ + return self._region + + @region.setter + def region(self, region): + """ + Sets the region of this ReplicaDetails. + The replica region + + + :param region: The region of this ReplicaDetails. + :type: str + """ + self._region = region + + @property + def status(self): + """ + Gets the status of this ReplicaDetails. + Replication status associated with a replicationId + + Allowed values for this property are: "REPLICATING", "REPLICATED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this ReplicaDetails. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this ReplicaDetails. + Replication status associated with a replicationId + + + :param status: The status of this ReplicaDetails. + :type: str + """ + allowed_values = ["REPLICATING", "REPLICATED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + 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/replication_status_details.py b/src/oci/key_management/models/replication_status_details.py new file mode 100644 index 0000000000..5669462bb2 --- /dev/null +++ b/src/oci/key_management/models/replication_status_details.py @@ -0,0 +1,66 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReplicationStatusDetails(object): + """ + Details of replication status across all replica regions + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReplicationStatusDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replica_details: + The value to assign to the replica_details property of this ReplicationStatusDetails. + :type replica_details: list[oci.key_management.models.ReplicaDetails] + + """ + self.swagger_types = { + 'replica_details': 'list[ReplicaDetails]' + } + + self.attribute_map = { + 'replica_details': 'replicaDetails' + } + + self._replica_details = None + + @property + def replica_details(self): + """ + Gets the replica_details of this ReplicationStatusDetails. + + :return: The replica_details of this ReplicationStatusDetails. + :rtype: list[oci.key_management.models.ReplicaDetails] + """ + return self._replica_details + + @replica_details.setter + def replica_details(self, replica_details): + """ + Sets the replica_details of this ReplicationStatusDetails. + + :param replica_details: The replica_details of this ReplicationStatusDetails. + :type: list[oci.key_management.models.ReplicaDetails] + """ + self._replica_details = replica_details + + 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/sign_data_details.py b/src/oci/key_management/models/sign_data_details.py index f78c9ba7db..5749b33509 100644 --- a/src/oci/key_management/models/sign_data_details.py +++ b/src/oci/key_management/models/sign_data_details.py @@ -119,7 +119,7 @@ def __init__(self, **kwargs): def message(self): """ **[Required]** Gets the message of this SignDataDetails. - The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. :return: The message of this SignDataDetails. @@ -131,7 +131,7 @@ def message(self): def message(self, message): """ Sets the message of this SignDataDetails. - The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. :param message: The message of this SignDataDetails. @@ -143,7 +143,7 @@ def message(self, message): def key_id(self): """ **[Required]** Gets the key_id of this SignDataDetails. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :return: The key_id of this SignDataDetails. @@ -155,7 +155,7 @@ def key_id(self): def key_id(self, key_id): """ Sets the key_id of this SignDataDetails. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :param key_id: The key_id of this SignDataDetails. @@ -167,7 +167,7 @@ def key_id(self, key_id): def key_version_id(self): """ Gets the key_version_id of this SignDataDetails. - The OCID of the keyVersion used to sign the message. + The OCID of the key version used to sign the message. :return: The key_version_id of this SignDataDetails. @@ -179,7 +179,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this SignDataDetails. - The OCID of the keyVersion used to sign the message. + The OCID of the key version used to sign the message. :param key_version_id: The key_version_id of this SignDataDetails. @@ -192,7 +192,7 @@ def message_type(self): """ Gets the message_type of this SignDataDetails. Denotes whether the value of the message parameter is a raw message or a message digest. - The default value, RAW, indicates a message. To indicate a message digest, use DIGEST. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. Allowed values for this property are: "RAW", "DIGEST" @@ -207,7 +207,7 @@ def message_type(self, message_type): """ Sets the message_type of this SignDataDetails. Denotes whether the value of the message parameter is a raw message or a message digest. - The default value, RAW, indicates a message. To indicate a message digest, use DIGEST. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. :param message_type: The message_type of this SignDataDetails. @@ -225,12 +225,12 @@ def message_type(self, message_type): def signing_algorithm(self): """ **[Required]** Gets the signing_algorithm of this SignDataDetails. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" @@ -244,12 +244,12 @@ def signing_algorithm(self): def signing_algorithm(self, signing_algorithm): """ Sets the signing_algorithm of this SignDataDetails. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. :param signing_algorithm: The signing_algorithm of this SignDataDetails. diff --git a/src/oci/key_management/models/signed_data.py b/src/oci/key_management/models/signed_data.py index bba6090189..3b8e5dfe63 100644 --- a/src/oci/key_management/models/signed_data.py +++ b/src/oci/key_management/models/signed_data.py @@ -104,7 +104,7 @@ def __init__(self, **kwargs): def key_id(self): """ **[Required]** Gets the key_id of this SignedData. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :return: The key_id of this SignedData. @@ -116,7 +116,7 @@ def key_id(self): def key_id(self, key_id): """ Sets the key_id of this SignedData. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :param key_id: The key_id of this SignedData. @@ -128,7 +128,7 @@ def key_id(self, key_id): def key_version_id(self): """ **[Required]** Gets the key_version_id of this SignedData. - The OCID of the keyVersion used to sign the message + The OCID of the key version used to sign the message. :return: The key_version_id of this SignedData. @@ -140,7 +140,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this SignedData. - The OCID of the keyVersion used to sign the message + The OCID of the key version used to sign the message. :param key_version_id: The key_version_id of this SignedData. @@ -152,7 +152,7 @@ def key_version_id(self, key_version_id): def signature(self): """ **[Required]** Gets the signature of this SignedData. - The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest. + The base64-encoded binary data object denoting the cryptographic signature generated for the message or message digest. :return: The signature of this SignedData. @@ -164,7 +164,7 @@ def signature(self): def signature(self, signature): """ Sets the signature of this SignedData. - The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest. + The base64-encoded binary data object denoting the cryptographic signature generated for the message or message digest. :param signature: The signature of this SignedData. @@ -176,12 +176,12 @@ def signature(self, signature): def signing_algorithm(self): """ **[Required]** Gets the signing_algorithm of this SignedData. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -196,12 +196,12 @@ def signing_algorithm(self): def signing_algorithm(self, signing_algorithm): """ Sets the signing_algorithm of this SignedData. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. :param signing_algorithm: The signing_algorithm of this SignedData. diff --git a/src/oci/key_management/models/vault.py b/src/oci/key_management/models/vault.py index 6ccc1011cc..a405518faa 100644 --- a/src/oci/key_management/models/vault.py +++ b/src/oci/key_management/models/vault.py @@ -122,6 +122,14 @@ def __init__(self, **kwargs): The value to assign to the wrappingkey_id property of this Vault. :type wrappingkey_id: str + :param replica_details: + The value to assign to the replica_details property of this Vault. + :type replica_details: oci.key_management.models.VaultReplicaDetails + + :param is_primary: + The value to assign to the is_primary property of this Vault. + :type is_primary: bool + """ self.swagger_types = { 'compartment_id': 'str', @@ -136,7 +144,9 @@ def __init__(self, **kwargs): 'time_of_deletion': 'datetime', 'vault_type': 'str', 'restored_from_vault_id': 'str', - 'wrappingkey_id': 'str' + 'wrappingkey_id': 'str', + 'replica_details': 'VaultReplicaDetails', + 'is_primary': 'bool' } self.attribute_map = { @@ -152,7 +162,9 @@ def __init__(self, **kwargs): 'time_of_deletion': 'timeOfDeletion', 'vault_type': 'vaultType', 'restored_from_vault_id': 'restoredFromVaultId', - 'wrappingkey_id': 'wrappingkeyId' + 'wrappingkey_id': 'wrappingkeyId', + 'replica_details': 'replicaDetails', + 'is_primary': 'isPrimary' } self._compartment_id = None @@ -168,6 +180,8 @@ def __init__(self, **kwargs): self._vault_type = None self._restored_from_vault_id = None self._wrappingkey_id = None + self._replica_details = None + self._is_primary = None @property def compartment_id(self): @@ -547,6 +561,46 @@ def wrappingkey_id(self, wrappingkey_id): """ self._wrappingkey_id = wrappingkey_id + @property + def replica_details(self): + """ + Gets the replica_details of this Vault. + + :return: The replica_details of this Vault. + :rtype: oci.key_management.models.VaultReplicaDetails + """ + return self._replica_details + + @replica_details.setter + def replica_details(self, replica_details): + """ + Sets the replica_details of this Vault. + + :param replica_details: The replica_details of this Vault. + :type: oci.key_management.models.VaultReplicaDetails + """ + self._replica_details = replica_details + + @property + def is_primary(self): + """ + Gets the is_primary of this Vault. + + :return: The is_primary of this Vault. + :rtype: bool + """ + return self._is_primary + + @is_primary.setter + def is_primary(self, is_primary): + """ + Sets the is_primary of this Vault. + + :param is_primary: The is_primary of this Vault. + :type: bool + """ + self._is_primary = is_primary + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/vault_replica_details.py b/src/oci/key_management/models/vault_replica_details.py new file mode 100644 index 0000000000..b47d164188 --- /dev/null +++ b/src/oci/key_management/models/vault_replica_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VaultReplicaDetails(object): + """ + Vault replica details + """ + + def __init__(self, **kwargs): + """ + Initializes a new VaultReplicaDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param replication_id: + The value to assign to the replication_id property of this VaultReplicaDetails. + :type replication_id: str + + """ + self.swagger_types = { + 'replication_id': 'str' + } + + self.attribute_map = { + 'replication_id': 'replicationId' + } + + self._replication_id = None + + @property + def replication_id(self): + """ + Gets the replication_id of this VaultReplicaDetails. + ReplicationId associated with a vault operation + + + :return: The replication_id of this VaultReplicaDetails. + :rtype: str + """ + return self._replication_id + + @replication_id.setter + def replication_id(self, replication_id): + """ + Sets the replication_id of this VaultReplicaDetails. + ReplicationId associated with a vault operation + + + :param replication_id: The replication_id of this VaultReplicaDetails. + :type: str + """ + self._replication_id = replication_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/key_management/models/vault_replica_summary.py b/src/oci/key_management/models/vault_replica_summary.py new file mode 100644 index 0000000000..6492a399ba --- /dev/null +++ b/src/oci/key_management/models/vault_replica_summary.py @@ -0,0 +1,183 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VaultReplicaSummary(object): + """ + Summary of vault replicas + """ + + #: A constant which can be used with the status property of a VaultReplicaSummary. + #: This constant has a value of "CREATING" + STATUS_CREATING = "CREATING" + + #: A constant which can be used with the status property of a VaultReplicaSummary. + #: This constant has a value of "CREATED" + STATUS_CREATED = "CREATED" + + #: A constant which can be used with the status property of a VaultReplicaSummary. + #: This constant has a value of "DELETING" + STATUS_DELETING = "DELETING" + + #: A constant which can be used with the status property of a VaultReplicaSummary. + #: This constant has a value of "DELETED" + STATUS_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new VaultReplicaSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param crypto_endpoint: + The value to assign to the crypto_endpoint property of this VaultReplicaSummary. + :type crypto_endpoint: str + + :param management_endpoint: + The value to assign to the management_endpoint property of this VaultReplicaSummary. + :type management_endpoint: str + + :param region: + The value to assign to the region property of this VaultReplicaSummary. + :type region: str + + :param status: + The value to assign to the status property of this VaultReplicaSummary. + Allowed values for this property are: "CREATING", "CREATED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + """ + self.swagger_types = { + 'crypto_endpoint': 'str', + 'management_endpoint': 'str', + 'region': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'crypto_endpoint': 'cryptoEndpoint', + 'management_endpoint': 'managementEndpoint', + 'region': 'region', + 'status': 'status' + } + + self._crypto_endpoint = None + self._management_endpoint = None + self._region = None + self._status = None + + @property + def crypto_endpoint(self): + """ + Gets the crypto_endpoint of this VaultReplicaSummary. + The vault replica's crypto endpoint + + + :return: The crypto_endpoint of this VaultReplicaSummary. + :rtype: str + """ + return self._crypto_endpoint + + @crypto_endpoint.setter + def crypto_endpoint(self, crypto_endpoint): + """ + Sets the crypto_endpoint of this VaultReplicaSummary. + The vault replica's crypto endpoint + + + :param crypto_endpoint: The crypto_endpoint of this VaultReplicaSummary. + :type: str + """ + self._crypto_endpoint = crypto_endpoint + + @property + def management_endpoint(self): + """ + Gets the management_endpoint of this VaultReplicaSummary. + The vault replica's management endpoint + + + :return: The management_endpoint of this VaultReplicaSummary. + :rtype: str + """ + return self._management_endpoint + + @management_endpoint.setter + def management_endpoint(self, management_endpoint): + """ + Sets the management_endpoint of this VaultReplicaSummary. + The vault replica's management endpoint + + + :param management_endpoint: The management_endpoint of this VaultReplicaSummary. + :type: str + """ + self._management_endpoint = management_endpoint + + @property + def region(self): + """ + Gets the region of this VaultReplicaSummary. + Region to which vault is replicated to + + + :return: The region of this VaultReplicaSummary. + :rtype: str + """ + return self._region + + @region.setter + def region(self, region): + """ + Sets the region of this VaultReplicaSummary. + Region to which vault is replicated to + + + :param region: The region of this VaultReplicaSummary. + :type: str + """ + self._region = region + + @property + def status(self): + """ + Gets the status of this VaultReplicaSummary. + Allowed values for this property are: "CREATING", "CREATED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this VaultReplicaSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this VaultReplicaSummary. + + :param status: The status of this VaultReplicaSummary. + :type: str + """ + allowed_values = ["CREATING", "CREATED", "DELETING", "DELETED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/verify_data_details.py b/src/oci/key_management/models/verify_data_details.py index c7cc50ab06..e8b76341f1 100644 --- a/src/oci/key_management/models/verify_data_details.py +++ b/src/oci/key_management/models/verify_data_details.py @@ -126,7 +126,7 @@ def __init__(self, **kwargs): def key_id(self): """ **[Required]** Gets the key_id of this VerifyDataDetails. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :return: The key_id of this VerifyDataDetails. @@ -138,7 +138,7 @@ def key_id(self): def key_id(self, key_id): """ Sets the key_id of this VerifyDataDetails. - The OCID of the key used to sign the message + The OCID of the key used to sign the message. :param key_id: The key_id of this VerifyDataDetails. @@ -150,7 +150,7 @@ def key_id(self, key_id): def key_version_id(self): """ **[Required]** Gets the key_version_id of this VerifyDataDetails. - The OCID of the keyVersion used to sign the message + The OCID of the key version used to sign the message. :return: The key_version_id of this VerifyDataDetails. @@ -162,7 +162,7 @@ def key_version_id(self): def key_version_id(self, key_version_id): """ Sets the key_version_id of this VerifyDataDetails. - The OCID of the keyVersion used to sign the message + The OCID of the key version used to sign the message. :param key_version_id: The key_version_id of this VerifyDataDetails. @@ -174,7 +174,7 @@ def key_version_id(self, key_version_id): def signature(self): """ **[Required]** Gets the signature of this VerifyDataDetails. - The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message. + The base64-encoded binary data object denoting the cryptographic signature generated for the message. :return: The signature of this VerifyDataDetails. @@ -186,7 +186,7 @@ def signature(self): def signature(self, signature): """ Sets the signature of this VerifyDataDetails. - The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message. + The base64-encoded binary data object denoting the cryptographic signature generated for the message. :param signature: The signature of this VerifyDataDetails. @@ -198,7 +198,8 @@ def signature(self, signature): def message_type(self): """ Gets the message_type of this VerifyDataDetails. - Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST. + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. Allowed values for this property are: "RAW", "DIGEST" @@ -212,7 +213,8 @@ def message_type(self): def message_type(self, message_type): """ Sets the message_type of this VerifyDataDetails. - Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST. + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. :param message_type: The message_type of this VerifyDataDetails. @@ -230,7 +232,7 @@ def message_type(self, message_type): def message(self): """ **[Required]** Gets the message of this VerifyDataDetails. - The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. :return: The message of this VerifyDataDetails. @@ -242,7 +244,7 @@ def message(self): def message(self, message): """ Sets the message of this VerifyDataDetails. - The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. :param message: The message of this VerifyDataDetails. @@ -254,12 +256,12 @@ def message(self, message): def signing_algorithm(self): """ **[Required]** Gets the signing_algorithm of this VerifyDataDetails. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" @@ -273,12 +275,12 @@ def signing_algorithm(self): def signing_algorithm(self, signing_algorithm): """ Sets the signing_algorithm of this VerifyDataDetails. - The algorithm to be used for signing the message or message digest - For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with - different Hashing algorithms. + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. - In case of passing digest for signing, make sure the same hashing algorithm is - specified as used for created for digest. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. :param signing_algorithm: The signing_algorithm of this VerifyDataDetails. diff --git a/src/oci/key_management/models/wrapped_import_key.py b/src/oci/key_management/models/wrapped_import_key.py index 1e887e53c0..e12a4e6d91 100644 --- a/src/oci/key_management/models/wrapped_import_key.py +++ b/src/oci/key_management/models/wrapped_import_key.py @@ -53,7 +53,7 @@ def __init__(self, **kwargs): def key_material(self): """ **[Required]** Gets the key_material of this WrappedImportKey. - The key material to import, wrapped by the vault's public RSA wrapping key and base64-encoded. + The key material to import, wrapped by the vault's RSA public wrapping key and base64-encoded. :return: The key_material of this WrappedImportKey. @@ -65,7 +65,7 @@ def key_material(self): def key_material(self, key_material): """ Sets the key_material of this WrappedImportKey. - The key material to import, wrapped by the vault's public RSA wrapping key and base64-encoded. + The key material to import, wrapped by the vault's RSA public wrapping key and base64-encoded. :param key_material: The key_material of this WrappedImportKey. @@ -78,10 +78,10 @@ def wrapping_algorithm(self): """ **[Required]** Gets the wrapping_algorithm of this WrappedImportKey. The wrapping mechanism to use during key import. - RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped - by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. + `RSA_OAEP_AES_SHA256` invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped + by the vault's RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. - RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key. + `RSA_OAEP_SHA256` means that the exportable key material is wrapped by the vault's RSA public wrapping key. Allowed values for this property are: "RSA_OAEP_SHA256", "RSA_OAEP_AES_SHA256" @@ -96,10 +96,10 @@ def wrapping_algorithm(self, wrapping_algorithm): """ Sets the wrapping_algorithm of this WrappedImportKey. The wrapping mechanism to use during key import. - RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped - by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. + `RSA_OAEP_AES_SHA256` invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped + by the vault's RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. - RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key. + `RSA_OAEP_SHA256` means that the exportable key material is wrapped by the vault's RSA public wrapping key. :param wrapping_algorithm: The wrapping_algorithm of this WrappedImportKey. diff --git a/src/oci/log_analytics/log_analytics_client.py b/src/oci/log_analytics/log_analytics_client.py index 02972a2818..6bfb107993 100644 --- a/src/oci/log_analytics/log_analytics_client.py +++ b/src/oci/log_analytics/log_analytics_client.py @@ -187,10 +187,102 @@ def add_entity_association(self, namespace_name, log_analytics_entity_id, add_en header_params=header_params, body=add_entity_association_details) + def add_source_event_types(self, namespace_name, source_name, add_event_type_details, **kwargs): + """ + Add one or more event types to a source. An event type and version can be enabled only on one source. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.EventTypeDetails add_event_type_details: (required) + Details of event types to be added to the source. The specified event type string could be the fully qualified name or a prefix that matches the event type. + + :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` + + :example: + Click `here `__ to see an example of how to use add_source_event_types API. + """ + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/addEventTypes" + 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( + "add_source_event_types got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "sourceName": source_name + } + + 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=add_event_type_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=add_event_type_details) + def append_lookup_data(self, namespace_name, lookup_name, append_lookup_file_body, **kwargs): """ - Append data to a lookup. The file containing the information to append - must be provided. + Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request. :param str namespace_name: (required) @@ -206,7 +298,7 @@ def append_lookup_data(self, namespace_name, lookup_name, append_lookup_file_bod is force :param str char_encoding: (optional) - Character Encoding + The character encoding of the uploaded file. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -322,7 +414,7 @@ def append_lookup_data(self, namespace_name, lookup_name, append_lookup_file_bod def batch_get_basic_info(self, namespace_name, basic_details, is_include_deleted, **kwargs): """ - get basic information about a specified set of labels + Lists basic information about a specified set of labels in batch. :param str namespace_name: (required) @@ -332,7 +424,7 @@ def batch_get_basic_info(self, namespace_name, basic_details, is_include_deleted List of label names to get information on :param bool is_include_deleted: (required) - flag for whether or not to include information on deleted labels + A flag specifying whether or not to include information on deleted labels. :param int limit: (optional) The maximum number of items to return. @@ -346,7 +438,7 @@ def batch_get_basic_info(self, namespace_name, basic_details, is_include_deleted Allowed values are: "ASC", "DESC" :param str basic_label_sort_by: (optional) - sort by label + The attribute used to sort the returned labels Allowed values are: "name", "priority" @@ -536,6 +628,108 @@ def cancel_query_work_request(self, namespace_name, work_request_id, **kwargs): path_params=path_params, header_params=header_params) + def change_log_analytics_em_bridge_compartment(self, namespace_name, log_analytics_em_bridge_id, change_log_analytics_em_bridge_compartment_details, **kwargs): + """ + Update the compartment of the log analytics enterprise manager bridge with the given id. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_em_bridge_id: (required) + The log analytics enterprise manager bridge OCID. + + :param oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails change_log_analytics_em_bridge_compartment_details: (required) + Log analytics enterprise manager bridge compartment Id 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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_log_analytics_em_bridge_compartment API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}/actions/changeCompartment" + 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( + "change_log_analytics_em_bridge_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "logAnalyticsEmBridgeId": log_analytics_em_bridge_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=change_log_analytics_em_bridge_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_log_analytics_em_bridge_compartment_details) + def change_log_analytics_entity_compartment(self, namespace_name, log_analytics_entity_id, change_log_analytics_entity_compartment_details, **kwargs): """ Update the compartment of the log analytics entity with the given id. @@ -640,7 +834,7 @@ def change_log_analytics_entity_compartment(self, namespace_name, log_analytics_ def change_log_analytics_log_group_compartment(self, namespace_name, log_analytics_log_group_id, change_log_analytics_log_group_compartment_details, **kwargs): """ - Updates the compartment of the Log-Analytics group with the given id. + Moves the specified log group to a different compartment. :param str namespace_name: (required) @@ -1044,6 +1238,97 @@ def clean(self, namespace_name, scheduled_task_id, **kwargs): query_params=query_params, header_params=header_params) + def create_log_analytics_em_bridge(self, namespace_name, create_log_analytics_em_bridge_details, **kwargs): + """ + Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails create_log_analytics_em_bridge_details: (required) + Details for the enterprise manager bridge. + + :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 :class:`~oci.log_analytics.models.LogAnalyticsEmBridge` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_log_analytics_em_bridge API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges" + 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_log_analytics_em_bridge got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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=create_log_analytics_em_bridge_details, + response_type="LogAnalyticsEmBridge") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_log_analytics_em_bridge_details, + response_type="LogAnalyticsEmBridge") + def create_log_analytics_entity(self, namespace_name, create_log_analytics_entity_details, **kwargs): """ Create a new log analytics entity. @@ -1226,7 +1511,7 @@ def create_log_analytics_entity_type(self, namespace_name, create_log_analytics_ def create_log_analytics_log_group(self, namespace_name, create_log_analytics_log_group_details, **kwargs): """ - Creates a new Log-Analytics group. + Creates a new log group in the specified compartment with the input display name. You may also specify optional information such as description, defined tags, and free-form tags. :param str namespace_name: (required) @@ -1488,7 +1773,7 @@ def create_scheduled_task(self, namespace_name, create_scheduled_task_details, * def delete_associations(self, namespace_name, delete_log_analytics_association_details, **kwargs): """ - delete associations + Deletes the associations between the sources and entities specified. :param str namespace_name: (required) @@ -1577,14 +1862,14 @@ def delete_associations(self, namespace_name, delete_log_analytics_association_d def delete_field(self, namespace_name, field_name, **kwargs): """ - delete field with specified name + Deletes field with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str field_name: (required) - name of the field to get + The field name. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -1674,14 +1959,14 @@ def delete_field(self, namespace_name, field_name, **kwargs): def delete_label(self, namespace_name, label_name, **kwargs): """ - delete a label + Deletes label with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str label_name: (required) - name of the label to get + The label name. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -1769,16 +2054,102 @@ def delete_label(self, namespace_name, label_name, **kwargs): path_params=path_params, header_params=header_params) - def delete_log_analytics_entity(self, namespace_name, log_analytics_entity_id, **kwargs): + def delete_log_analytics_em_bridge(self, namespace_name, log_analytics_em_bridge_id, **kwargs): """ - Delete log analytics entity with the given id. + Delete log analytics enterprise manager bridge with the given id. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param str log_analytics_entity_id: (required) - The log analytics entity OCID. + :param str log_analytics_em_bridge_id: (required) + The log analytics enterprise manager bridge OCID. + + :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` + + :example: + Click `here `__ to see an example of how to use delete_log_analytics_em_bridge API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}" + 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_log_analytics_em_bridge got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "logAnalyticsEmBridgeId": log_analytics_em_bridge_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 delete_log_analytics_entity(self, namespace_name, log_analytics_entity_id, **kwargs): + """ + Delete log analytics entity with the given id. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_entity_id: (required) + The log analytics entity OCID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -1943,7 +2314,7 @@ def delete_log_analytics_entity_type(self, namespace_name, entity_type_name, **k def delete_log_analytics_log_group(self, namespace_name, log_analytics_log_group_id, **kwargs): """ - Deletes the Log-Analytics group with the given id. + Deletes the specified log group. The log group cannot be part of an active association or have an active upload. :param str namespace_name: (required) @@ -2118,7 +2489,7 @@ def delete_log_analytics_object_collection_rule(self, namespace_name, log_analyt def delete_lookup(self, namespace_name, lookup_name, **kwargs): """ - Delete the specified lookup. + Deletes lookup with the specified name. :param str namespace_name: (required) @@ -2226,14 +2597,14 @@ def delete_lookup(self, namespace_name, lookup_name, **kwargs): def delete_parser(self, namespace_name, parser_name, **kwargs): """ - delete parser with specified name + Deletes parser with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str parser_name: (required) - parserName + The parser name. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2410,14 +2781,14 @@ def delete_scheduled_task(self, namespace_name, scheduled_task_id, **kwargs): def delete_source(self, namespace_name, source_name, **kwargs): """ - delete source with specified ID + Deletes source with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str source_name: (required) - source name + The source name. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2839,24 +3210,32 @@ def disable_archiving(self, namespace_name, **kwargs): header_params=header_params, response_type="Success") - def enable_archiving(self, namespace_name, **kwargs): + def disable_auto_association(self, namespace_name, source_name, disable_auto_association_details, **kwargs): """ - THis API enables archiving. + Disables auto association for a log source. In the future, this log source would not be automatically + associated with any entity that becomes eligible for association. In addition, you may also optionally + remove all existing associations for this log source. :param str namespace_name: (required) The Logging Analytics namespace used for the request. + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.DisableAutoAssociationDetails disable_auto_association_details: (required) + Details required to disable auto association for the log source. + + :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 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 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. @@ -2865,28 +3244,29 @@ def enable_archiving(self, namespace_name, **kwargs): 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.log_analytics.models.Success` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use enable_archiving API. + Click `here `__ to see an example of how to use disable_auto_association API. """ - resource_path = "/namespaces/{namespaceName}/storage/actions/enableArchiving" + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/disableAutoAssociation" method = "POST" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_request_id", - "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( - "enable_archiving got unknown kwargs: {!r}".format(extra_kwargs)) + "disable_auto_association got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name + "namespaceName": namespace_name, + "sourceName": source_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2898,8 +3278,8 @@ def enable_archiving(self, namespace_name, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing), - "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} @@ -2908,34 +3288,36 @@ def enable_archiving(self, namespace_name, **kwargs): 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="Success") + body=disable_auto_association_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - response_type="Success") + body=disable_auto_association_details) - def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_details, **kwargs): + def disable_source_event_types(self, namespace_name, source_name, disable_event_type_details, **kwargs): """ - This API estimates the size of data to be purged based based on time interval, purge query etc. + Disable one or more event types in a source. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param oci.log_analytics.models.EstimatePurgeDataSizeDetails estimate_purge_data_size_details: (required) - This is the input to estimate the size of data to be purged. + :param str source_name: (required) + The source name. - :param str opc_request_id: (optional) - The client request ID for tracing. + :param oci.log_analytics.models.EventTypeDetails disable_event_type_details: (required) + Details of event types to be disabled in the source. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2944,12 +3326,8 @@ def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_deta has been deleted and purged from the system, then a retry of the original creation request might be rejected. - :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. @@ -2959,29 +3337,29 @@ def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_deta 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.log_analytics.models.EstimatePurgeDataSizeResult` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use estimate_purge_data_size API. + Click `here `__ to see an example of how to use disable_source_event_types API. """ - resource_path = "/namespaces/{namespaceName}/storage/actions/estimatePurgeDataSize" + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/disableEventTypes" method = "POST" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_request_id", "opc_retry_token", - "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( - "estimate_purge_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + "disable_source_event_types got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name + "namespaceName": namespace_name, + "sourceName": source_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2993,9 +3371,8 @@ def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_deta 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), - "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} @@ -3012,31 +3389,33 @@ def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_deta method=method, path_params=path_params, header_params=header_params, - body=estimate_purge_data_size_details, - response_type="EstimatePurgeDataSizeResult") + body=disable_event_type_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=estimate_purge_data_size_details, - response_type="EstimatePurgeDataSizeResult") + body=disable_event_type_details) - def estimate_recall_data_size(self, namespace_name, estimate_recall_data_size_details, **kwargs): + def enable_archiving(self, namespace_name, **kwargs): """ - This API gives an active storage usage estimate for archived data to be recalled and the time range of such data. + THis API enables archiving. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param oci.log_analytics.models.EstimateRecallDataSizeDetails estimate_recall_data_size_details: (required) - This is the input to estimate the size of data to be recalled. - :param str opc_request_id: (optional) The client request ID for tracing. + :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 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. @@ -3045,24 +3424,25 @@ def estimate_recall_data_size(self, namespace_name, estimate_recall_data_size_de 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.log_analytics.models.EstimateRecallDataSizeResult` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.log_analytics.models.Success` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use estimate_recall_data_size API. + Click `here `__ to see an example of how to use enable_archiving API. """ - resource_path = "/namespaces/{namespaceName}/storage/actions/estimateRecallDataSize" + resource_path = "/namespaces/{namespaceName}/storage/actions/enableArchiving" method = "POST" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_request_id" + "opc_request_id", + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "estimate_recall_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + "enable_archiving got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "namespaceName": namespace_name @@ -3077,7 +3457,8 @@ def estimate_recall_data_size(self, namespace_name, estimate_recall_data_size_de header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -3092,27 +3473,37 @@ def estimate_recall_data_size(self, namespace_name, estimate_recall_data_size_de method=method, path_params=path_params, header_params=header_params, - body=estimate_recall_data_size_details, - response_type="EstimateRecallDataSizeResult") + response_type="Success") else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=estimate_recall_data_size_details, - response_type="EstimateRecallDataSizeResult") + response_type="Success") - def estimate_release_data_size(self, namespace_name, estimate_release_data_size_details, **kwargs): + def enable_auto_association(self, namespace_name, source_name, enable_auto_association_details, **kwargs): """ - This API gives an active storage usage estimate for recalled data to be released and the time range of such data. + Enables auto association for a log source. This would initiate immediate association of the source + to any eligible entities it is not already associated with, and would also ensure the log source gets + associated with entities that are added or become eligible in the future. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param oci.log_analytics.models.EstimateReleaseDataSizeDetails estimate_release_data_size_details: (required) - This is the input to estimate the size of recalled data to be released. + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.EnableAutoAssociationDetails enable_auto_association_details: (required) + Details required to enable auto association for the log source. + + :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. @@ -3125,27 +3516,29 @@ def estimate_release_data_size(self, namespace_name, estimate_release_data_size_ 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.log_analytics.models.EstimateReleaseDataSizeResult` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use estimate_release_data_size API. + Click `here `__ to see an example of how to use enable_auto_association API. """ - resource_path = "/namespaces/{namespaceName}/storage/actions/estimateReleaseDataSize" + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/enableAutoAssociation" 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( - "estimate_release_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + "enable_auto_association got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name + "namespaceName": namespace_name, + "sourceName": source_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3157,6 +3550,7 @@ def estimate_release_data_size(self, namespace_name, estimate_release_data_size_ 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} @@ -3166,33 +3560,36 @@ def estimate_release_data_size(self, namespace_name, estimate_release_data_size_ 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=estimate_release_data_size_details, - response_type="EstimateReleaseDataSizeResult") + body=enable_auto_association_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=estimate_release_data_size_details, - response_type="EstimateReleaseDataSizeResult") + body=enable_auto_association_details) - def export_custom_content(self, namespace_name, export_custom_content_details, **kwargs): + def enable_source_event_types(self, namespace_name, source_name, enable_event_type_details, **kwargs): """ - export + Enable one or more event types in a source. An event type and version can be enabled only in one source. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param oci.log_analytics.models.ExportContent export_custom_content_details: (required) - content to export + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.EventTypeDetails enable_event_type_details: (required) + Details of event types to be enabled in the source. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -3212,13 +3609,13 @@ def export_custom_content(self, namespace_name, export_custom_content_details, * 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 stream + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use export_custom_content API. + Click `here `__ to see an example of how to use enable_source_event_types API. """ - resource_path = "/namespaces/{namespaceName}/contents/actions/exportCustomContent" + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/enableEventTypes" method = "POST" # Don't accept unknown kwargs @@ -3230,10 +3627,11 @@ def export_custom_content(self, namespace_name, export_custom_content_details, * extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "export_custom_content got unknown kwargs: {!r}".format(extra_kwargs)) + "enable_source_event_types got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name + "namespaceName": namespace_name, + "sourceName": source_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3243,7 +3641,7 @@ def export_custom_content(self, namespace_name, export_custom_content_details, * raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) header_params = { - "accept": "application/octet-stream", + "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) @@ -3263,38 +3661,387 @@ def export_custom_content(self, namespace_name, export_custom_content_details, * method=method, path_params=path_params, header_params=header_params, - body=export_custom_content_details, - response_type="stream") + body=enable_event_type_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=export_custom_content_details, - response_type="stream") + body=enable_event_type_details) - def export_query_result(self, namespace_name, export_details, **kwargs): + def estimate_purge_data_size(self, namespace_name, estimate_purge_data_size_details, **kwargs): """ - Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout. + This API estimates the size of data to be purged based based on time interval, purge query etc. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param oci.log_analytics.models.ExportDetails export_details: (required) - Query to be exported + :param oci.log_analytics.models.EstimatePurgeDataSizeDetails estimate_purge_data_size_details: (required) + This is the input to estimate the size of data to be purged. :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 `__. + :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. - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + :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 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.log_analytics.models.EstimatePurgeDataSizeResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use estimate_purge_data_size API. + """ + resource_path = "/namespaces/{namespaceName}/storage/actions/estimatePurgeDataSize" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "estimate_purge_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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), + "if-match": kwargs.get("if_match", 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=estimate_purge_data_size_details, + response_type="EstimatePurgeDataSizeResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=estimate_purge_data_size_details, + response_type="EstimatePurgeDataSizeResult") + + def estimate_recall_data_size(self, namespace_name, estimate_recall_data_size_details, **kwargs): + """ + This API gives an active storage usage estimate for archived data to be recalled and the time range of such data. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.EstimateRecallDataSizeDetails estimate_recall_data_size_details: (required) + This is the input to estimate the size of data to be recalled. + + :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.log_analytics.models.EstimateRecallDataSizeResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use estimate_recall_data_size API. + """ + resource_path = "/namespaces/{namespaceName}/storage/actions/estimateRecallDataSize" + 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( + "estimate_recall_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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, + body=estimate_recall_data_size_details, + response_type="EstimateRecallDataSizeResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=estimate_recall_data_size_details, + response_type="EstimateRecallDataSizeResult") + + def estimate_release_data_size(self, namespace_name, estimate_release_data_size_details, **kwargs): + """ + This API gives an active storage usage estimate for recalled data to be released and the time range of such data. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.EstimateReleaseDataSizeDetails estimate_release_data_size_details: (required) + This is the input to estimate the size of recalled data to be released. + + :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.log_analytics.models.EstimateReleaseDataSizeResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use estimate_release_data_size API. + """ + resource_path = "/namespaces/{namespaceName}/storage/actions/estimateReleaseDataSize" + 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( + "estimate_release_data_size got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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, + body=estimate_release_data_size_details, + response_type="EstimateReleaseDataSizeResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=estimate_release_data_size_details, + response_type="EstimateReleaseDataSizeResult") + + def export_custom_content(self, namespace_name, export_custom_content_details, **kwargs): + """ + Exports all custom details of the specified sources, parsers, fields and labels, in zip format. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.ExportContent export_custom_content_details: (required) + content to export + + :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 stream + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use export_custom_content API. + """ + resource_path = "/namespaces/{namespaceName}/contents/actions/exportCustomContent" + 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( + "export_custom_content got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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/octet-stream", + "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=export_custom_content_details, + response_type="stream") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=export_custom_content_details, + response_type="stream") + + def export_query_result(self, namespace_name, export_details, **kwargs): + """ + Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.ExportDetails export_details: (required) + Query to be exported + + :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 stream :rtype: :class:`~oci.response.Response` @@ -3356,7 +4103,7 @@ def export_query_result(self, namespace_name, export_details, **kwargs): def extract_structured_log_field_paths(self, namespace_name, logan_parser_details, **kwargs): """ - structured log fieldpaths + Extracts the field paths from the example json or xml content. :param str namespace_name: (required) @@ -3366,7 +4113,7 @@ def extract_structured_log_field_paths(self, namespace_name, logan_parser_detail parser definition :param str parser_type: (optional) - type - possible values are xml or json + The parser type - possible values are XML or JSON. Allowed values are: "XML", "JSON" @@ -3467,7 +4214,7 @@ def extract_structured_log_field_paths(self, namespace_name, logan_parser_detail def extract_structured_log_header_paths(self, namespace_name, logan_parser_details, **kwargs): """ - structured log header paths + Extracts the header paths from the example json or xml content. :param str namespace_name: (required) @@ -3477,7 +4224,7 @@ def extract_structured_log_header_paths(self, namespace_name, logan_parser_detai parser definition :param str parser_type: (optional) - type - possible values are xml or json + The parser type - possible values are XML or JSON. Allowed values are: "XML", "JSON" @@ -3658,7 +4405,7 @@ def filter(self, namespace_name, filter_details, **kwargs): def get_association_summary(self, namespace_name, compartment_id, **kwargs): """ - association summary + Returns the count of source associations for entities in the specified compartment. :param str namespace_name: (required) @@ -3743,14 +4490,14 @@ def get_association_summary(self, namespace_name, compartment_id, **kwargs): def get_column_names(self, namespace_name, sql_query, **kwargs): """ - extract column names from SQL query + Extracts column names from the input SQL query. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str sql_query: (required) - sql query to get the columns + The SQL query from which column names are to be extracted. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -3839,7 +4586,7 @@ def get_column_names(self, namespace_name, sql_query, **kwargs): def get_config_work_request(self, namespace_name, work_request_id, **kwargs): """ - association summary by source + Returns detailed information about the configuration work request with the specified id. :param str namespace_name: (required) @@ -3920,14 +4667,14 @@ def get_config_work_request(self, namespace_name, work_request_id, **kwargs): def get_field(self, namespace_name, field_name, **kwargs): """ - get common field with specified name + Gets detailed information about the field with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str field_name: (required) - name of the field to get + The field name. :param str opc_request_id: (optional) The client request ID for tracing. @@ -3999,14 +4746,14 @@ def get_field(self, namespace_name, field_name, **kwargs): def get_fields_summary(self, namespace_name, **kwargs): """ - get field summary + Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param bool is_show_detail: (optional) - show detail flag + A boolean indicating whether or not to display detailed field summary information :param str opc_request_id: (optional) The client request ID for tracing. @@ -4085,14 +4832,14 @@ def get_fields_summary(self, namespace_name, **kwargs): def get_label(self, namespace_name, label_name, **kwargs): """ - get label with specified name + Gets detailed information about the label with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str label_name: (required) - name of the label to get + The label name. :param str opc_request_id: (optional) The client request ID for tracing. @@ -4164,7 +4911,7 @@ def get_label(self, namespace_name, label_name, **kwargs): def get_label_summary(self, namespace_name, **kwargs): """ - get total count + Returns the count of labels. :param str namespace_name: (required) @@ -4237,6 +4984,170 @@ def get_label_summary(self, namespace_name, **kwargs): header_params=header_params, response_type="LabelSummaryReport") + def get_log_analytics_em_bridge(self, namespace_name, log_analytics_em_bridge_id, **kwargs): + """ + Retrieve the log analytics enterprise manager bridge with the given id. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_em_bridge_id: (required) + The log analytics enterprise manager bridge OCID. + + :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.log_analytics.models.LogAnalyticsEmBridge` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_log_analytics_em_bridge API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}" + 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_log_analytics_em_bridge got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "logAnalyticsEmBridgeId": log_analytics_em_bridge_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="LogAnalyticsEmBridge") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="LogAnalyticsEmBridge") + + def get_log_analytics_em_bridge_summary(self, namespace_name, compartment_id, **kwargs): + """ + Returns log analytics enterprise manager bridges summary report. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :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 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.log_analytics.models.LogAnalyticsEmBridgeSummaryReport` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_log_analytics_em_bridge_summary API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges/emBridgeSummary" + 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_log_analytics_em_bridge_summary got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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 + } + 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="LogAnalyticsEmBridgeSummaryReport") + 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="LogAnalyticsEmBridgeSummaryReport") + def get_log_analytics_entities_summary(self, namespace_name, compartment_id, **kwargs): """ Returns log analytics entities count summary report. @@ -4482,7 +5393,7 @@ def get_log_analytics_entity_type(self, namespace_name, entity_type_name, **kwar def get_log_analytics_log_group(self, namespace_name, log_analytics_log_group_id, **kwargs): """ - Retrieves the Log-Analytics group with the given id. + Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags. :param str namespace_name: (required) @@ -4561,7 +5472,7 @@ def get_log_analytics_log_group(self, namespace_name, log_analytics_log_group_id def get_log_analytics_log_groups_summary(self, namespace_name, compartment_id, **kwargs): """ - Returns a count of Log-Analytics groups. + Returns the count of log groups in a compartment. :param str namespace_name: (required) @@ -4727,15 +5638,91 @@ def get_log_analytics_object_collection_rule(self, namespace_name, log_analytics def get_lookup(self, namespace_name, lookup_name, **kwargs): """ - Obtains the lookup with the specified reference. + Gets detailed information about the lookup with the specified name. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str lookup_name: (required) + The name of the lookup to operate on. + + :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.log_analytics.models.LogAnalyticsLookup` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_lookup API. + """ + resource_path = "/namespaces/{namespaceName}/lookups/{lookupName}" + 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_lookup got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "lookupName": lookup_name + } + + 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="LogAnalyticsLookup") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="LogAnalyticsLookup") + + def get_lookup_summary(self, namespace_name, **kwargs): + """ + Returns the count of user created and oracle defined lookups. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param str lookup_name: (required) - The name of the lookup to operate on. - :param str opc_request_id: (optional) The client request ID for tracing. @@ -4747,13 +5734,13 @@ def get_lookup(self, namespace_name, lookup_name, **kwargs): 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.log_analytics.models.LogAnalyticsLookup` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.log_analytics.models.LookupSummaryReport` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_lookup API. + Click `here `__ to see an example of how to use get_lookup_summary API. """ - resource_path = "/namespaces/{namespaceName}/lookups/{lookupName}" + resource_path = "/namespaces/{namespaceName}/lookupSummary" method = "GET" # Don't accept unknown kwargs @@ -4764,11 +5751,10 @@ def get_lookup(self, namespace_name, lookup_name, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "get_lookup got unknown kwargs: {!r}".format(extra_kwargs)) + "get_lookup_summary got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name, - "lookupName": lookup_name + "namespaceName": namespace_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4795,14 +5781,14 @@ def get_lookup(self, namespace_name, lookup_name, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="LogAnalyticsLookup") + response_type="LookupSummaryReport") else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - response_type="LogAnalyticsLookup") + response_type="LookupSummaryReport") def get_namespace(self, namespace_name, **kwargs): """ @@ -4881,14 +5867,14 @@ def get_namespace(self, namespace_name, **kwargs): def get_parser(self, namespace_name, parser_name, **kwargs): """ - get parser with fields by Name + Gets detailed information about the parser with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str parser_name: (required) - parserName + The parser name. :param str opc_request_id: (optional) The client request ID for tracing. @@ -4960,7 +5946,7 @@ def get_parser(self, namespace_name, parser_name, **kwargs): def get_parser_summary(self, namespace_name, **kwargs): """ - parser summary + Returns the count of parsers. :param str namespace_name: (required) @@ -5318,14 +6304,14 @@ def get_scheduled_task(self, namespace_name, scheduled_task_id, **kwargs): def get_source(self, namespace_name, source_name, compartment_id, **kwargs): """ - get source with specified name + Gets detailed information about the source with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str source_name: (required) - source name + The source name. :param str compartment_id: (required) The ID of the compartment in which to list resources. @@ -5407,7 +6393,7 @@ def get_source(self, namespace_name, source_name, compartment_id, **kwargs): def get_source_summary(self, namespace_name, **kwargs): """ - source summary + Returns the count of sources. :param str namespace_name: (required) @@ -5875,7 +6861,7 @@ def get_work_request(self, namespace_name, work_request_id, **kwargs): def import_custom_content(self, namespace_name, import_custom_content_file_body, **kwargs): """ - register custom content + Imports the specified custom content from the input in zip format. :param str namespace_name: (required) @@ -5885,7 +6871,8 @@ def import_custom_content(self, namespace_name, import_custom_content_file_body, The file to upload which contains the custom content. :param bool is_overwrite: (optional) - is overwrite + A flag indicating whether or not to overwrite existing content if a conflict is + found during import content operation. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -5989,9 +6976,156 @@ def import_custom_content(self, namespace_name, import_custom_content_file_body, body=import_custom_content_file_body, response_type="LogAnalyticsImportCustomContent") + def list_associable_entities(self, namespace_name, source_name, compartment_id, **kwargs): + """ + Lists the entities in the specified compartment which are (in)eligible for association with this source. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str type: (optional) + The entity type - either eligible or ineligible for association. + + Allowed values are: "ELIGIBLE", "INELIGIBLE" + + :param str search_text: (optional) + The text used for filtering returned entities. Search text is applicable to the + entity name and the entity description. + + :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_by: (optional) + The attribute used to sort the returned entities + + Allowed values are: "entityName", "entityTypeName", "host", "agentId" + + :param str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + Allowed values are: "ASC", "DESC" + + :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.log_analytics.models.AssociableEntityCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_associable_entities API. + """ + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/associableEntities" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "type", + "search_text", + "limit", + "page", + "sort_by", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_associable_entities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "sourceName": source_name + } + + 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)) + + if 'type' in kwargs: + type_allowed_values = ["ELIGIBLE", "INELIGIBLE"] + if kwargs['type'] not in type_allowed_values: + raise ValueError( + "Invalid value for `type`, must be one of {0}".format(type_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["entityName", "entityTypeName", "host", "agentId"] + 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 = { + "compartmentId": compartment_id, + "type": kwargs.get("type", missing), + "searchText": kwargs.get("search_text", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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;charset=UTF-8", + "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="AssociableEntityCollection") + 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="AssociableEntityCollection") + def list_associated_entities(self, namespace_name, compartment_id, **kwargs): """ - list of entities that have been associated to at least one source + Lists the association details of entities in the specified compartment that are associated with at least one source. :param str namespace_name: (required) @@ -6004,10 +7138,12 @@ def list_associated_entities(self, namespace_name, compartment_id, **kwargs): The entity OCID. :param str entity_type: (optional) - entity type name + The entity type used for filtering. Only associations on an entity with the + specified type will be returned. :param str entity_type_display_name: (optional) - entity type display name + The entity type display name used for filtering. Only items associated with the entity + with the specified type display name will be returned. :param int limit: (optional) The maximum number of items to return. @@ -6021,7 +7157,7 @@ def list_associated_entities(self, namespace_name, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by field + The attribute used to sort the returned entities Allowed values are: "entityName", "entityTypeDisplayName", "associationCount" @@ -6079,22 +7215,145 @@ def list_associated_entities(self, namespace_name, compartment_id, **kwargs): "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) ) - if 'sort_by' in kwargs: - sort_by_allowed_values = ["entityName", "entityTypeDisplayName", "associationCount"] - 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_by' in kwargs: + sort_by_allowed_values = ["entityName", "entityTypeDisplayName", "associationCount"] + 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 = { + "entityId": kwargs.get("entity_id", missing), + "entityType": kwargs.get("entity_type", missing), + "entityTypeDisplayName": kwargs.get("entity_type_display_name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "compartmentId": compartment_id + } + 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;charset=UTF-8", + "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="LogAnalyticsAssociatedEntityCollection") + 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="LogAnalyticsAssociatedEntityCollection") + + def list_auto_associations(self, namespace_name, source_name, **kwargs): + """ + Gets information related to auto association for the source with the specified name. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :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_by: (optional) + The attribute used to sort the returned auto association information. + + Allowed values are: "isEnabled" + + :param str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + Allowed values are: "ASC", "DESC" + + :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.log_analytics.models.AutoAssociationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_auto_associations API. + """ + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/autoAssociations" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "limit", + "page", + "sort_by", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_auto_associations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "sourceName": source_name + } + + 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)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["isEnabled"] + 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 = { - "entityId": kwargs.get("entity_id", missing), - "entityType": kwargs.get("entity_type", missing), - "entityTypeDisplayName": kwargs.get("entity_type_display_name", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "sortOrder": kwargs.get("sort_order", missing), "sortBy": kwargs.get("sort_by", missing), - "compartmentId": compartment_id + "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} @@ -6117,7 +7376,7 @@ def list_associated_entities(self, namespace_name, compartment_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="LogAnalyticsAssociatedEntityCollection") + response_type="AutoAssociationCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -6125,11 +7384,11 @@ def list_associated_entities(self, namespace_name, compartment_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="LogAnalyticsAssociatedEntityCollection") + response_type="AutoAssociationCollection") def list_config_work_requests(self, namespace_name, compartment_id, **kwargs): """ - association summary by source + Returns the list of configuration work requests such as association or lookup operations, containing detailed information about them. You may paginate or limit the number of results. :param str namespace_name: (required) @@ -6144,7 +7403,7 @@ def list_config_work_requests(self, namespace_name, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - work requests sort by + The attribute used to sort the returned work requests Allowed values are: "timeAccepted" @@ -6384,7 +7643,7 @@ def list_entity_associations(self, namespace_name, log_analytics_entity_id, **kw def list_entity_source_associations(self, namespace_name, compartment_id, **kwargs): """ - entity associations summary + Returns the list of source associations for the specified entity. :param str namespace_name: (required) @@ -6397,18 +7656,21 @@ def list_entity_source_associations(self, namespace_name, compartment_id, **kwar The entity OCID. :param str entity_type: (optional) - entity type name + The entity type used for filtering. Only associations on an entity with the + specified type will be returned. :param str entity_type_display_name: (optional) - entity type display name + The entity type display name used for filtering. Only items associated with the entity + with the specified type display name will be returned. :param str life_cycle_state: (optional) - Status + The life cycle state used for filtering. Only associations with the specified + life cycle state will be returned. Allowed values are: "ALL", "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED" :param bool is_show_total: (optional) - is Show Total + A flag indicating whether or not to return the total number of items returned. :param int limit: (optional) The maximum number of items to return. @@ -6422,7 +7684,7 @@ def list_entity_source_associations(self, namespace_name, compartment_id, **kwar Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by field + The attribute used to sort the returned associations Allowed values are: "sourceDisplayName", "timeLastAttempted", "status" @@ -6541,31 +7803,40 @@ def list_entity_source_associations(self, namespace_name, compartment_id, **kwar def list_fields(self, namespace_name, **kwargs): """ - get all common field with specified display name and description + Returns a list of log fields, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by specifying various options including parser and source names. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param bool is_match_all: (optional) - isMatchAll + A flag indicating how to handle filtering when multiple filter criteria are specified. + A value of true will always result in the most expansive list of items being returned. + For example, if two field lists are supplies as filter criteria, a value of true will + result in any item matching a field in either list being returned, while a value of + false will result in a list of items which only have fields contained in both input lists. :param str source_ids: (optional) - comma delimited list of source ids + A list of source IDs used for filtering. Only fields used by the specified + sources will be returned. :param str source_names: (optional) - comma delimited list of source Names + A list of source names used for filtering. Only fields used by the specified + sources will be returned. :param str parser_type: (optional) - parserType + The parser type used for filtering. Only items with, or associated with, parsers + of the specified type will be returned. - Allowed values are: "ALL", "REGEX", "XML", "JSON" + Allowed values are: "ALL", "REGEX", "XML", "JSON", "ODL", "DELIMITED" :param str parser_ids: (optional) - comma delimited list of parser ids + A list of parser names used for filtering. Only fields used by the specified + parsers will be returned. :param str parser_names: (optional) - comma delimited list of parser names + A list of parser names used for filtering. Only fields used by the specified + parsers will be returned. :param bool is_include_parser: (optional) isIncludeParser @@ -6585,7 +7856,7 @@ def list_fields(self, namespace_name, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by field + The attribute used to sort the returned fields Allowed values are: "name", "dataType" @@ -6642,7 +7913,7 @@ def list_fields(self, namespace_name, **kwargs): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) if 'parser_type' in kwargs: - parser_type_allowed_values = ["ALL", "REGEX", "XML", "JSON"] + parser_type_allowed_values = ["ALL", "REGEX", "XML", "JSON", "ODL", "DELIMITED"] if kwargs['parser_type'] not in parser_type_allowed_values: raise ValueError( "Invalid value for `parser_type`, must be one of {0}".format(parser_type_allowed_values) @@ -6709,7 +7980,7 @@ def list_fields(self, namespace_name, **kwargs): def list_label_priorities(self, namespace_name, **kwargs): """ - get list of priorities + Lists the available problem priorities that could be associated with a label. :param str namespace_name: (required) @@ -6800,14 +8071,15 @@ def list_label_priorities(self, namespace_name, **kwargs): def list_label_source_details(self, namespace_name, **kwargs): """ - get details of sources using the label + Lists sources using the label, along with configuration details like base field, operator and condition. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str label_name: (optional) - label name + The label name used for filtering. Only items with, or associated with, the + specified label name will be returned. :param int limit: (optional) The maximum number of items to return. @@ -6821,7 +8093,7 @@ def list_label_source_details(self, namespace_name, **kwargs): Allowed values are: "ASC", "DESC" :param str label_source_sort_by: (optional) - sort by source displayname + The attribute used to sort the returned sources Allowed values are: "sourceDisplayName", "labelFieldDisplayName" @@ -6924,33 +8196,38 @@ def list_label_source_details(self, namespace_name, **kwargs): def list_labels(self, namespace_name, **kwargs): """ - get labels passing specified filter + Returns a list of labels, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as label name, display name, description and priority. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str label_name: (optional) - label name + The label name used for filtering. Only items with, or associated with, the + specified label name will be returned. :param str label_display_text: (optional) - search by label display name or description + The label display text used for filtering. Only labels with the specified name or + description will be returned. :param str is_system: (optional) - Is system param of value (all, custom, sourceUsing) + The system value used for filtering. Only items with the specified system value + will be returned. Valid values are built in, custom (for user defined items), or + all (for all items, regardless of system value). Allowed values are: "ALL", "CUSTOM", "BUILT_IN" :param str label_priority: (optional) - label priority + The label priority used for filtering. Only labels with the specified + priority will be returned. Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH" :param bool is_count_pop: (optional) - isCountPop + A flag indicating whether or not to count the label usage per source and per rule. :param bool is_alias_pop: (optional) - isAliasPop + A flag indicating whether or not return the aliases used by each label. :param int limit: (optional) The maximum number of items to return. @@ -6964,7 +8241,7 @@ def list_labels(self, namespace_name, **kwargs): Allowed values are: "ASC", "DESC" :param str label_sort_by: (optional) - sort by label + The attribute used to sort the returned labels Allowed values are: "name", "priority", "sourceUsing" @@ -7089,6 +8366,171 @@ def list_labels(self, namespace_name, **kwargs): header_params=header_params, response_type="LogAnalyticsLabelCollection") + def list_log_analytics_em_bridges(self, namespace_name, compartment_id, **kwargs): + """ + Return a list of log analytics enterprise manager bridges. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str display_name: (optional) + A filter to return only log analytics enterprise manager bridge name whose name matches the entire name given. The match + is case-insensitive. + + :param list[str] lifecycle_state: (optional) + A filter to return only log analytics enterprise manager bridges matching all the lifecycle states specified for this parameter. + + Allowed values are: "CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION" + + :param str lifecycle_details_contains: (optional) + A filter to return only log analytics enterprise manager bridges whose lifecycleDetails contains the specified string. + + :param list[str] import_status: (optional) + Filter by the processing status of the latest upload from enterprise manager. + + Allowed values are: "NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS" + + :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 ascending (`ASC`) or descending (`DESC`). + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort enterprise manager bridges by. Only one sort order may be provided. Default order for timeCreated and timeUpdated + is descending. Default order for enterprise manager name is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "timeUpdated", "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 :class:`~oci.log_analytics.models.LogAnalyticsEmBridgeCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_log_analytics_em_bridges API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "display_name", + "lifecycle_state", + "lifecycle_details_contains", + "import_status", + "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_log_analytics_em_bridges got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION"] + for lifecycle_state_item in kwargs['lifecycle_state']: + if lifecycle_state_item not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'import_status' in kwargs: + import_status_allowed_values = ["NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS"] + for import_status_item in kwargs['import_status']: + if import_status_item not in import_status_allowed_values: + raise ValueError( + "Invalid value for `import_status`, must be one of {0}".format(import_status_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", "timeUpdated", "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": self.base_client.generate_collection_format_param(kwargs.get("lifecycle_state", missing), 'multi'), + "lifecycleDetailsContains": kwargs.get("lifecycle_details_contains", missing), + "importStatus": self.base_client.generate_collection_format_param(kwargs.get("import_status", missing), 'multi'), + "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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="LogAnalyticsEmBridgeCollection") + 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="LogAnalyticsEmBridgeCollection") + def list_log_analytics_entities(self, namespace_name, compartment_id, **kwargs): """ Return a list of log analytics entities. @@ -7139,6 +8581,14 @@ def list_log_analytics_entities(self, namespace_name, compartment_id, **kwargs): :param str source_id: (optional) A filter to return only log analytics entities whose sourceId matches the sourceId given. + :param list[str] creation_source_type: (optional) + A filter to return only those log analytics entities with the specified auto-creation source. + + Allowed values are: "EM_BRIDGE", "SERVICE_CONNECTOR_HUB", "NONE" + + :param str creation_source_details: (optional) + A filter to return only log analytics entities whose auto-creation source details contains the specified string. + :param int limit: (optional) The maximum number of items to return. @@ -7189,6 +8639,8 @@ def list_log_analytics_entities(self, namespace_name, compartment_id, **kwargs): "hostname", "hostname_contains", "source_id", + "creation_source_type", + "creation_source_details", "limit", "page", "sort_order", @@ -7224,6 +8676,14 @@ def list_log_analytics_entities(self, namespace_name, compartment_id, **kwargs): "Invalid value for `is_management_agent_id_null`, must be one of {0}".format(is_management_agent_id_null_allowed_values) ) + if 'creation_source_type' in kwargs: + creation_source_type_allowed_values = ["EM_BRIDGE", "SERVICE_CONNECTOR_HUB", "NONE"] + for creation_source_type_item in kwargs['creation_source_type']: + if creation_source_type_item not in creation_source_type_allowed_values: + raise ValueError( + "Invalid value for `creation_source_type`, must be one of {0}".format(creation_source_type_allowed_values) + ) + if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] if kwargs['sort_order'] not in sort_order_allowed_values: @@ -7250,6 +8710,8 @@ def list_log_analytics_entities(self, namespace_name, compartment_id, **kwargs): "hostname": kwargs.get("hostname", missing), "hostnameContains": kwargs.get("hostname_contains", missing), "sourceId": kwargs.get("source_id", missing), + "creationSourceType": self.base_client.generate_collection_format_param(kwargs.get("creation_source_type", missing), 'multi'), + "creationSourceDetails": kwargs.get("creation_source_details", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -7305,7 +8767,7 @@ def list_log_analytics_entity_types(self, namespace_name, **kwargs): :param str cloud_type: (optional) A filter to return CLOUD or NON_CLOUD entity types. - Allowed values are: "CLOUD", "NON_CLOUD" + Allowed values are: "CLOUD", "NON_CLOUD", "ALL" :param str lifecycle_state: (optional) A filter to return only those log analytics entities with the specified lifecycle state. The state @@ -7379,7 +8841,7 @@ def list_log_analytics_entity_types(self, namespace_name, **kwargs): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) if 'cloud_type' in kwargs: - cloud_type_allowed_values = ["CLOUD", "NON_CLOUD"] + cloud_type_allowed_values = ["CLOUD", "NON_CLOUD", "ALL"] if kwargs['cloud_type'] not in cloud_type_allowed_values: raise ValueError( "Invalid value for `cloud_type`, must be one of {0}".format(cloud_type_allowed_values) @@ -7449,7 +8911,7 @@ def list_log_analytics_entity_types(self, namespace_name, **kwargs): def list_log_analytics_log_groups(self, namespace_name, compartment_id, **kwargs): """ - Returns a list of Log-Analytics groups. + Returns a list of log groups in a compartment. You may limit the number of log groups, provide sorting options, and filter the results by specifying a display name. :param str namespace_name: (required) @@ -7719,25 +9181,132 @@ def list_log_analytics_object_collection_rules(self, namespace_name, compartment header_params=header_params, response_type="LogAnalyticsObjectCollectionRuleCollection") + def list_log_sets(self, namespace_name, **kwargs): + """ + This API returns a list of log sets. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the 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 str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + 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 :class:`~oci.log_analytics.models.LogSetCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_log_sets API. + """ + resource_path = "/namespaces/{namespaceName}/storage/logSets" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "limit", + "page", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_log_sets got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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)) + + 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), + "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, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="LogSetCollection") + 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="LogSetCollection") + def list_lookups(self, namespace_name, type, **kwargs): """ - Obtains a list of lookups. The list is filtered according to the filter criteria - specified by the user, and sorted according to the ordering criteria specified. + Returns a list of lookups, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as lookup name, description and type. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str type: (required) - type - possible values are Lookup or Dictionary + The lookup type. Valid values are Lookup or Dictionary. Allowed values are: "Lookup", "Dictionary" :param str lookup_display_text: (optional) - Search by lookup display name or description. + The lookup text used for filtering. Only lookups with the specified name + or description will be returned. :param str is_system: (optional) - Is system param of value (all, custom, sourceUsing) + The system value used for filtering. Only items with the specified system value + will be returned. Valid values are built in, custom (for user defined items), or + all (for all items, regardless of system value). Allowed values are: "ALL", "CUSTOM", "BUILT_IN" @@ -7749,10 +9318,10 @@ def list_lookups(self, namespace_name, type, **kwargs): :param str status: (optional) The lookup status used for filtering when fetching a list of lookups. - Allowed values are: "ALL", "SUCCESFUL", "FAILED", "INPROGRESS" + Allowed values are: "ALL", "SUCCESSFUL", "FAILED", "INPROGRESS" :param bool is_hide_special: (optional) - is include items + A flag indicating whether or not to return OMC annotated or hidden lookups. :param int limit: (optional) The maximum number of items to return. @@ -7834,7 +9403,7 @@ def list_lookups(self, namespace_name, type, **kwargs): ) if 'status' in kwargs: - status_allowed_values = ["ALL", "SUCCESFUL", "FAILED", "INPROGRESS"] + status_allowed_values = ["ALL", "SUCCESSFUL", "FAILED", "INPROGRESS"] if kwargs['status'] not in status_allowed_values: raise ValueError( "Invalid value for `status`, must be one of {0}".format(status_allowed_values) @@ -7891,7 +9460,7 @@ def list_lookups(self, namespace_name, type, **kwargs): def list_meta_source_types(self, namespace_name, **kwargs): """ - get all meta source types + Lists the types of log sources supported. :param str namespace_name: (required) @@ -7904,7 +9473,7 @@ def list_meta_source_types(self, namespace_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by field + The attribute used to sort the returned items Allowed values are: "name" @@ -8081,14 +9650,14 @@ def list_namespaces(self, compartment_id, **kwargs): def list_parser_functions(self, namespace_name, **kwargs): """ - get pre-process plugin instance + Lists the parser functions defined for the specified parser. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str parser_name: (optional) - parserName + The parser name used for filtering. :param int limit: (optional) The maximum number of items to return. @@ -8097,7 +9666,7 @@ def list_parser_functions(self, namespace_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by field + The attribute used to sort the returned items Allowed values are: "name" @@ -8205,7 +9774,7 @@ def list_parser_functions(self, namespace_name, **kwargs): def list_parser_meta_plugins(self, namespace_name, **kwargs): """ - get pre-process Meta plugins + Lists the parser meta plugins available for defining parser functions. :param str namespace_name: (required) @@ -8218,7 +9787,7 @@ def list_parser_meta_plugins(self, namespace_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by field + The attribute used to sort the returned items Allowed values are: "name" @@ -8324,33 +9893,42 @@ def list_parser_meta_plugins(self, namespace_name, **kwargs): def list_parsers(self, namespace_name, **kwargs): """ - List parsers passing specified filter + Returns a list of parsers, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as parser name, type, display name and description. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param bool is_match_all: (optional) - isMatchAll + A flag indicating how to handle filtering when multiple filter criteria are specified. + A value of true will always result in the most expansive list of items being returned. + For example, if two field lists are supplies as filter criteria, a value of true will + result in any item matching a field in either list being returned, while a value of + false will result in a list of items which only have fields contained in both input lists. :param str source_type: (optional) - source type + The source type used for filtering. Only parsers associated with a source of the + specified type will be returned. Allowed values are: "OS_FILE", "SYSLOG", "ODL", "OS_WINDOWS_SYS" :param str parser_name: (optional) - parserName + The parser name used for filtering. :param str parser_display_text: (optional) - search by parser display name or description + The parser display text used for filtering. Only parsers with the specified name + or description will be returned. :param str parser_type: (optional) - parserType + The parser type used for filtering. Only items with, or associated with, parsers + of the specified type will be returned. - Allowed values are: "ALL", "REGEX", "XML", "JSON" + Allowed values are: "ALL", "REGEX", "XML", "JSON", "ODL", "DELIMITED" :param str is_system: (optional) - Is system param of value (all, custom, sourceUsing) + The system value used for filtering. Only items with the specified system value + will be returned. Valid values are built in, custom (for user defined items), or + all (for all items, regardless of system value). Allowed values are: "ALL", "CUSTOM", "BUILT_IN" @@ -8366,7 +9944,7 @@ def list_parsers(self, namespace_name, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by parser + The attribute used to sort the returned parsers Allowed values are: "name", "type", "sourcesCount", "timeUpdated" @@ -8428,7 +10006,7 @@ def list_parsers(self, namespace_name, **kwargs): ) if 'parser_type' in kwargs: - parser_type_allowed_values = ["ALL", "REGEX", "XML", "JSON"] + parser_type_allowed_values = ["ALL", "REGEX", "XML", "JSON", "ODL", "DELIMITED"] if kwargs['parser_type'] not in parser_type_allowed_values: raise ValueError( "Invalid value for `parser_type`, must be one of {0}".format(parser_type_allowed_values) @@ -8803,6 +10381,13 @@ def list_scheduled_tasks(self, namespace_name, task_type, compartment_id, **kwar Allowed values are: "timeCreated", "timeUpdated", "displayName" + :param str saved_search_id: (optional) + A filter to return only scheduled tasks whose stream action savedSearchId matches the given + ManagementSavedSearch id [OCID] exactly. + + :param str display_name_contains: (optional) + A filter to return only resources whose display name contains the substring. + :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. @@ -8828,7 +10413,9 @@ def list_scheduled_tasks(self, namespace_name, task_type, compartment_id, **kwar "page", "display_name", "sort_order", - "sort_by" + "sort_by", + "saved_search_id", + "display_name_contains" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -8872,7 +10459,9 @@ def list_scheduled_tasks(self, namespace_name, task_type, compartment_id, **kwar "page": kwargs.get("page", missing), "displayName": kwargs.get("display_name", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "sortBy": kwargs.get("sort_by", missing), + "savedSearchId": kwargs.get("saved_search_id", missing), + "displayNameContains": kwargs.get("display_name_contains", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -8907,14 +10496,14 @@ def list_scheduled_tasks(self, namespace_name, task_type, compartment_id, **kwar def list_source_associations(self, namespace_name, source_name, compartment_id, **kwargs): """ - association summary by source + Returns the list of entity associations in the input compartment for the specified source. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str source_name: (required) - sourceName + The souce name used for filtering associations. :param str compartment_id: (required) The ID of the compartment in which to list resources. @@ -8923,12 +10512,13 @@ def list_source_associations(self, namespace_name, source_name, compartment_id, The entity OCID. :param str life_cycle_state: (optional) - Status + The life cycle state used for filtering. Only associations with the specified + life cycle state will be returned. Allowed values are: "ALL", "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED" :param bool is_show_total: (optional) - is Show Total + A flag indicating whether or not to return the total number of items returned. :param str opc_request_id: (optional) The client request ID for tracing. @@ -8945,7 +10535,7 @@ def list_source_associations(self, namespace_name, source_name, compartment_id, Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by field + The attribute used to sort the returned associations Allowed values are: "entityName", "timeLastAttempted", "status" @@ -9056,16 +10646,166 @@ def list_source_associations(self, namespace_name, source_name, compartment_id, header_params=header_params, response_type="LogAnalyticsAssociationCollection") + def list_source_event_types(self, namespace_name, source_name, **kwargs): + """ + Lists the event types mapped to the source with the specified name. The event type string could be the fully qualified name or a prefix that matches the event type. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :param str display_text: (optional) + The text used for filtering event types by name or description. + + :param str is_system: (optional) + The system value used for filtering. Only items with the specified system value + will be returned. Valid values are built in, custom (for user defined items), or + all (for all items, regardless of system value). + + Allowed values are: "ALL", "CUSTOM", "BUILT_IN" + + :param bool is_enabled: (optional) + The enabled flag used for filtering. Only items with the specified enabled value + will be returned. + + :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_by: (optional) + The attribute used to sort the returned source event types. + + Allowed values are: "eventType", "timeUpdated" + + :param str sort_order: (optional) + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + + Allowed values are: "ASC", "DESC" + + :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.log_analytics.models.EventTypeCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_source_event_types API. + """ + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/eventTypes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "display_text", + "is_system", + "is_enabled", + "limit", + "page", + "sort_by", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_source_event_types got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "sourceName": source_name + } + + 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)) + + if 'is_system' in kwargs: + is_system_allowed_values = ["ALL", "CUSTOM", "BUILT_IN"] + if kwargs['is_system'] not in is_system_allowed_values: + raise ValueError( + "Invalid value for `is_system`, must be one of {0}".format(is_system_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["eventType", "timeUpdated"] + 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 = { + "displayText": kwargs.get("display_text", missing), + "isSystem": kwargs.get("is_system", missing), + "isEnabled": kwargs.get("is_enabled", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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;charset=UTF-8", + "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="EventTypeCollection") + 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="EventTypeCollection") + def list_source_extended_field_definitions(self, namespace_name, source_name, **kwargs): """ - get source extended fields for source with specified Id + Lists the extended field definitions for the source with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str source_name: (required) - source name + The source name. :param int limit: (optional) The maximum number of items to return. @@ -9074,7 +10814,7 @@ def list_source_extended_field_definitions(self, namespace_name, source_name, ** The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by source extended field definition + The attribute used to sort the returned source patterns Allowed values are: "baseFieldName", "regularExpression" @@ -9181,7 +10921,7 @@ def list_source_extended_field_definitions(self, namespace_name, source_name, ** def list_source_label_operators(self, namespace_name, **kwargs): """ - list source label operators + Lists the supported conditional operators that could be used for matching log field values to generate a label. You may use patterns to specify a condition. If a log entry matches that condition, it is tagged with the corresponding label. :param str namespace_name: (required) @@ -9194,7 +10934,7 @@ def list_source_label_operators(self, namespace_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by field + The attribute used to sort the returned items Allowed values are: "name" @@ -9300,7 +11040,7 @@ def list_source_label_operators(self, namespace_name, **kwargs): def list_source_meta_functions(self, namespace_name, **kwargs): """ - get source meta functions + Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields. :param str namespace_name: (required) @@ -9313,7 +11053,7 @@ def list_source_meta_functions(self, namespace_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by field + The attribute used to sort the returned items Allowed values are: "name" @@ -9419,14 +11159,14 @@ def list_source_meta_functions(self, namespace_name, **kwargs): def list_source_patterns(self, namespace_name, source_name, **kwargs): """ - get source patterns for source with specified Id + Lists the source patterns for the source with the specified name. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str source_name: (required) - source name + The source name. :param bool is_include: (optional) is included source patterns @@ -9438,7 +11178,7 @@ def list_source_patterns(self, namespace_name, source_name, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str sort_by: (optional) - sort by source pattern text + The attribute used to sort the returned source patterns Allowed values are: "patternText" @@ -9547,7 +11287,7 @@ def list_source_patterns(self, namespace_name, source_name, **kwargs): def list_sources(self, namespace_name, compartment_id, **kwargs): """ - source list + Returns a list of sources, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as display name, description and entity type. :param str namespace_name: (required) @@ -9557,18 +11297,23 @@ def list_sources(self, namespace_name, compartment_id, **kwargs): The ID of the compartment in which to list resources. :param str entity_type: (optional) - entityType + A filter to return only sources associated with entities of the specified type. + The match is case-insensitive. :param str source_display_text: (optional) - Search by source display name or description. + The source display text used for filtering. Only sources with the specified name + or description will be returned. :param str is_system: (optional) - Is system param of value (all, custom, sourceUsing) + The system value used for filtering. Only items with the specified system value + will be returned. Valid values are built in, custom (for user defined items), or + all (for all items, regardless of system value). Allowed values are: "ALL", "CUSTOM", "BUILT_IN" :param bool is_auto_associated: (optional) - auto association flag + An auto-associate flag used for filtering. Only sources which are marked for automatic + association will be returned. :param str sort_order: (optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). @@ -9576,7 +11321,7 @@ def list_sources(self, namespace_name, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by source + The attribute used to sort the returned sources Allowed values are: "name", "timeUpdated", "associationCount", "sourceType" @@ -9591,7 +11336,10 @@ def list_sources(self, namespace_name, compartment_id, **kwargs): is case-insensitive. :param bool is_simplified: (optional) - is simplified + A flag specifying whether or not to return all source information, or a subset of the + information about each source. A value of true will return only the source unique + identifier and the source name. A value of false will return all source information + (such as author, updated date, system flag, etc.) :param str opc_request_id: (optional) The client request ID for tracing. @@ -10465,6 +12213,12 @@ def list_uploads(self, namespace_name, **kwargs): :param str opc_request_id: (optional) The client request ID for tracing. + :param str warnings_filter: (optional) + Use this for filtering uploads w.r.t warnings. Only one value is allowed. If no value is specified then ALL is taken as default, + which means that all the uploads with and without warnings will be returned. + + Allowed values are: "WITH_WARNINGS", "WITHOUT_WARNINGS", "ALL" + :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. @@ -10491,7 +12245,8 @@ def list_uploads(self, namespace_name, **kwargs): "page", "sort_order", "sort_by", - "opc_request_id" + "opc_request_id", + "warnings_filter" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -10522,13 +12277,21 @@ def list_uploads(self, namespace_name, **kwargs): "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) + if 'warnings_filter' in kwargs: + warnings_filter_allowed_values = ["WITH_WARNINGS", "WITHOUT_WARNINGS", "ALL"] + if kwargs['warnings_filter'] not in warnings_filter_allowed_values: + raise ValueError( + "Invalid value for `warnings_filter`, must be one of {0}".format(warnings_filter_allowed_values) + ) + query_params = { "name": kwargs.get("name", missing), "nameContains": kwargs.get("name_contains", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "sortBy": kwargs.get("sort_by", missing), + "warningsFilter": kwargs.get("warnings_filter", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -10563,8 +12326,7 @@ def list_uploads(self, namespace_name, **kwargs): def list_warnings(self, namespace_name, compartment_id, **kwargs): """ - Obtains a list of warnings. The list is filtered according to the filter criteria - specified by the user, and sorted according to the ordering criteria specified. + Returns a list of collection warnings, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as start time, end time, warning type, warning state, source name, source pattern and entity name. :param str namespace_name: (required) @@ -10582,25 +12344,30 @@ def list_warnings(self, namespace_name, compartment_id, **kwargs): Allowed values are: "ALL", "SUPPRESSED", "UNSUPPRESSED" :param str source_name: (optional) - sourceName + The source name. :param str source_pattern: (optional) - sourcePattern + The source pattern used for filtering. Only warnings associated with a source with the + specified pattern will be returned. :param str warning_message: (optional) warning message query parameter :param str entity_name: (optional) - entityName + The entity name used for filtering. Only warnings associated with an entity with the + specified name will be returned. :param str entity_type: (optional) - entity type name + The entity type used for filtering. Only associations on an entity with the + specified type will be returned. :param str warning_type: (optional) The warning type query parameter. :param bool is_no_source: (optional) - isNoSource + A flag indicating whether to filter warnings based on source display name or on warning level. + A value of true will filter based on warning level (rule, source, or pattern), while a + value of false will filter based on source display name. :param str start_time: (optional) The warning start date query parameter. @@ -11758,14 +13525,14 @@ def recall_archived_data(self, namespace_name, recall_archived_data_details, **k def register_lookup(self, namespace_name, type, register_lookup_content_file_body, **kwargs): """ - register lookup + Creates a lookup with the specified name, type and description. The csv file containing the lookup content is passed in as binary data in the request. :param str namespace_name: (required) The Logging Analytics namespace used for the request. :param str type: (required) - type - possible values are Lookup or Dictionary + The lookup type. Valid values are Lookup or Dictionary. Allowed values are: "Lookup", "Dictionary" @@ -11777,13 +13544,13 @@ def register_lookup(self, namespace_name, type, register_lookup_content_file_bod is case-insensitive. :param str description: (optional) - Description of the fields to get + The description for a created lookup. :param str char_encoding: (optional) - Character Encoding + The character encoding of the uploaded file. :param bool is_hidden: (optional) - is hidden + A flag indicating whether or not the new lookup should be hidden. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -11921,13 +13688,114 @@ def release_recalled_data(self, namespace_name, release_recalled_data_details, * has been deleted and purged from the system, then a retry of the original creation request might be rejected. - :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use release_recalled_data API. + """ + resource_path = "/namespaces/{namespaceName}/storage/actions/releaseRecalledData" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "release_recalled_data got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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), + "if-match": kwargs.get("if_match", 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=release_recalled_data_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=release_recalled_data_details) + + def remove_entity_associations(self, namespace_name, log_analytics_entity_id, remove_entity_associations_details, **kwargs): + """ + Delete association between input source log analytics entity and destination entities. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_entity_id: (required) + The log analytics entity OCID. + + :param oci.log_analytics.models.RemoveEntityAssociationsDetails remove_entity_associations_details: (required) + This parameter specifies the entity OCIDs with which associations are 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 + 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 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 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. @@ -11940,25 +13808,26 @@ def release_recalled_data(self, namespace_name, release_recalled_data_details, * :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use release_recalled_data API. + Click `here `__ to see an example of how to use remove_entity_associations API. """ - resource_path = "/namespaces/{namespaceName}/storage/actions/releaseRecalledData" + resource_path = "/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/removeEntityAssociations" method = "POST" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "if_match", "opc_request_id", - "opc_retry_token", - "if_match" + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "release_recalled_data got unknown kwargs: {!r}".format(extra_kwargs)) + "remove_entity_associations got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "namespaceName": namespace_name + "namespaceName": namespace_name, + "logAnalyticsEntityId": log_analytics_entity_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -11970,9 +13839,9 @@ def release_recalled_data(self, namespace_name, release_recalled_data_details, * 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), - "if-match": kwargs.get("if_match", 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} @@ -11989,38 +13858,28 @@ def release_recalled_data(self, namespace_name, release_recalled_data_details, * method=method, path_params=path_params, header_params=header_params, - body=release_recalled_data_details) + body=remove_entity_associations_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=release_recalled_data_details) + body=remove_entity_associations_details) - def remove_entity_associations(self, namespace_name, log_analytics_entity_id, remove_entity_associations_details, **kwargs): + def remove_source_event_types(self, namespace_name, source_name, remove_event_type_details, **kwargs): """ - Delete association between input source log analytics entity and destination entities. + Remove one or more event types from a source. :param str namespace_name: (required) The Logging Analytics namespace used for the request. - :param str log_analytics_entity_id: (required) - The log analytics entity OCID. - - :param oci.log_analytics.models.RemoveEntityAssociationsDetails remove_entity_associations_details: (required) - This parameter specifies the entity OCIDs with which associations are 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 - 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 source_name: (required) + The source name. - :param str opc_request_id: (optional) - The client request ID for tracing. + :param oci.log_analytics.models.EventTypeDetails remove_event_type_details: (required) + Details of event types to be removed from the source. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -12029,6 +13888,9 @@ def remove_entity_associations(self, namespace_name, log_analytics_entity_id, re 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. @@ -12041,26 +13903,25 @@ def remove_entity_associations(self, namespace_name, log_analytics_entity_id, re :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use remove_entity_associations API. + Click `here `__ to see an example of how to use remove_source_event_types API. """ - resource_path = "/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/removeEntityAssociations" + resource_path = "/namespaces/{namespaceName}/sources/{sourceName}/actions/removeEventTypes" method = "POST" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "if_match", - "opc_request_id", - "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: raise ValueError( - "remove_entity_associations got unknown kwargs: {!r}".format(extra_kwargs)) + "remove_source_event_types got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "namespaceName": namespace_name, - "logAnalyticsEntityId": log_analytics_entity_id + "sourceName": source_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -12072,9 +13933,8 @@ def remove_entity_associations(self, namespace_name, log_analytics_entity_id, re 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) + "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} @@ -12091,14 +13951,14 @@ def remove_entity_associations(self, namespace_name, log_analytics_entity_id, re method=method, path_params=path_params, header_params=header_params, - body=remove_entity_associations_details) + body=remove_event_type_details) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, header_params=header_params, - body=remove_entity_associations_details) + body=remove_event_type_details) def resume_scheduled_task(self, namespace_name, scheduled_task_id, **kwargs): """ @@ -12380,9 +14240,7 @@ def suggest(self, namespace_name, suggest_details, **kwargs): def suppress_warning(self, namespace_name, warning_reference_details, compartment_id, **kwargs): """ - Accepts a list of warnings. Any unsuppressed warnings in the input list will - be suppressed. Warnings in the input list which are already suppressed will - not be modified. + Supresses a list of warnings. Any unsuppressed warnings in the input list would be suppressed. Warnings in the input list which are already suppressed will not be modified. :param str namespace_name: (required) @@ -12481,7 +14339,7 @@ def suppress_warning(self, namespace_name, warning_reference_details, compartmen def test_parser(self, namespace_name, test_parser_payload_details, **kwargs): """ - test parser + Tests the parser definition against the specified example content to ensure fields are successfully extracted. :param str namespace_name: (required) @@ -12491,12 +14349,13 @@ def test_parser(self, namespace_name, test_parser_payload_details, **kwargs): Details for test payload :param str scope: (optional) - scope + The scope used when testing a parser. Allowed values are: "LOG_LINES", "LOG_ENTRIES", "LOG_LINES_LOG_ENTRIES" :param str req_origin_module: (optional) - module + The module to test. A value of 'ParserFunctionTest' will result in testing of + the parser functions. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -12597,9 +14456,7 @@ def test_parser(self, namespace_name, test_parser_payload_details, **kwargs): def unsuppress_warning(self, namespace_name, warning_reference_details, compartment_id, **kwargs): """ - Accepts a list of warnings. Any suppressed warnings in the input list will - be unsuppressed. Warnings in the input list which are unsuppressed will - not be modified. + Unsupresses a list of warnings. Any suppressed warnings in the input list would be unsuppressed. Warnings in the input list which are already unsuppressed will not be modified. :param str namespace_name: (required) @@ -12696,6 +14553,99 @@ def unsuppress_warning(self, namespace_name, warning_reference_details, compartm header_params=header_params, body=warning_reference_details) + def update_log_analytics_em_bridge(self, namespace_name, log_analytics_em_bridge_id, update_log_analytics_em_bridge_details, **kwargs): + """ + Update log analytics enterprise manager bridge with the given id. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_em_bridge_id: (required) + The log analytics enterprise manager bridge OCID. + + :param oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails update_log_analytics_em_bridge_details: (required) + Log analytics enterprise manager 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 :class:`~oci.log_analytics.models.LogAnalyticsEmBridge` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_log_analytics_em_bridge API. + """ + resource_path = "/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}" + 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_log_analytics_em_bridge got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name, + "logAnalyticsEmBridgeId": log_analytics_em_bridge_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_log_analytics_em_bridge_details, + response_type="LogAnalyticsEmBridge") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_log_analytics_em_bridge_details, + response_type="LogAnalyticsEmBridge") + def update_log_analytics_entity(self, namespace_name, log_analytics_entity_id, update_log_analytics_entity_details, **kwargs): """ Update the log analytics entity with the given id. @@ -12882,7 +14832,7 @@ def update_log_analytics_entity_type(self, namespace_name, update_log_analytics_ def update_log_analytics_log_group(self, namespace_name, log_analytics_log_group_id, update_log_analytics_log_group_details, **kwargs): """ - Updates the Log-Analytics group with the given id. + Updates the specified log group's display name, description, defined tags, and free-form tags. :param str namespace_name: (required) @@ -13174,8 +15124,7 @@ def update_lookup(self, namespace_name, lookup_name, update_lookup_metadata_deta def update_lookup_data(self, namespace_name, lookup_name, update_lookup_file_body, **kwargs): """ - Updates the specified lookup with the details provided. This API will not update - lookup metadata (such as lookup description). + Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the request. :param str namespace_name: (required) @@ -13191,7 +15140,7 @@ def update_lookup_data(self, namespace_name, lookup_name, update_lookup_file_bod is force :param str char_encoding: (optional) - Character Encoding + The character encoding of the uploaded file. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -13489,6 +15438,149 @@ def update_storage(self, namespace_name, update_storage_details, **kwargs): body=update_storage_details, response_type="Storage") + def upload_log_events_file(self, namespace_name, log_group_id, upload_log_events_file_details, **kwargs): + """ + Accepts log events for processing by Logging Analytics. + + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_group_id: (required) + The log group OCID that gets mapped to the uploaded logs. + + :param stream upload_log_events_file_details: (required) + Log events data to be uploaded. The data could be uploaded with or without logSet information depending on whether logSet is enabled for the tenancy or not. Supported formats include + 1. json file : logSet (if needed) should be sent as \"logSet\" query parameter + 2. gzip file : logSet (if needed) should be sent as \"logSet\" query parameter + 3. zip file : containing multiple json files. LogSet information (if needed) should be appended to every filename in the zip. + Supported filename format with logSet detail is <filename>_logSet=<logset>.json + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str log_set: (optional) + The log set that gets associated with the uploaded logs. + + :param str payload_type: (optional) + Identifies the type of request payload. + + Allowed values are: "JSON", "GZIP", "ZIP" + + :param str content_type: (optional) + The content type of the log data. + + :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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use upload_log_events_file API. + """ + resource_path = "/namespaces/{namespaceName}/actions/uploadLogEventsFile" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "log_set", + "payload_type", + "content_type", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "upload_log_events_file got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "namespaceName": namespace_name + } + + 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)) + + if 'payload_type' in kwargs: + payload_type_allowed_values = ["JSON", "GZIP", "ZIP"] + if kwargs['payload_type'] not in payload_type_allowed_values: + raise ValueError( + "Invalid value for `payload_type`, must be one of {0}".format(payload_type_allowed_values) + ) + + query_params = { + "logGroupId": log_group_id, + "logSet": kwargs.get("log_set", missing), + "payloadType": kwargs.get("payload_type", 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", + "opc-request-id": kwargs.get("opc_request_id", missing), + "content-type": kwargs.get("content_type", 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} + + # If the body parameter is optional we need to assign it to a variable so additional type checking can be performed. + try: + upload_log_events_file_details + except NameError: + upload_log_events_file_details = kwargs.get("upload_log_events_file_details", missing) + + if upload_log_events_file_details is not missing and upload_log_events_file_details is not None: + if (not isinstance(upload_log_events_file_details, (six.binary_type, six.string_types)) and + not hasattr(upload_log_events_file_details, "read")): + raise TypeError('The body must be a string, bytes, or provide a read() method.') + + if hasattr(upload_log_events_file_details, 'fileno') and hasattr(upload_log_events_file_details, 'name') and upload_log_events_file_details.name != '': + if requests.utils.super_len(upload_log_events_file_details) == 0: + header_params['Content-Length'] = '0' + + 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, + query_params=query_params, + header_params=header_params, + body=upload_log_events_file_details, + enforce_content_headers=False) + 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, + body=upload_log_events_file_details, + enforce_content_headers=False) + def upload_log_file(self, namespace_name, upload_name, log_source_name, filename, opc_meta_loggrpid, upload_log_file_body, **kwargs): """ Accepts log data for processing by Logging Analytics. @@ -13551,6 +15643,9 @@ def upload_log_file(self, namespace_name, upload_name, log_source_name, filename has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param str log_set: (optional) + The log set that gets associated with the uploaded logs. + :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. @@ -13580,7 +15675,8 @@ def upload_log_file(self, namespace_name, upload_name, log_source_name, filename "opc_request_id", "content_md5", "content_type", - "opc_retry_token" + "opc_retry_token", + "log_set" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -13606,7 +15702,8 @@ def upload_log_file(self, namespace_name, upload_name, log_source_name, filename "dateFormat": kwargs.get("date_format", missing), "dateYear": kwargs.get("date_year", missing), "invalidateCache": kwargs.get("invalidate_cache", missing), - "filename": filename + "filename": filename, + "logSet": kwargs.get("log_set", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -13665,7 +15762,7 @@ def upload_log_file(self, namespace_name, upload_name, log_source_name, filename def upsert_associations(self, namespace_name, upsert_log_analytics_association_details, **kwargs): """ - create or update associations for a source + Creates or updates associations between sources and entities. All entities should belong to the specified input compartment. :param str namespace_name: (required) @@ -13765,7 +15862,7 @@ def upsert_associations(self, namespace_name, upsert_log_analytics_association_d def upsert_field(self, namespace_name, upsert_log_analytics_field_details, **kwargs): """ - Defines or update a field. + Creates or updates a field that could be used in parser expressions to extract and assign value. To create a field, specify its display name. A name would be generated for the field. For subsequent calls to update the field, include the name attribute. :param str namespace_name: (required) @@ -13865,7 +15962,7 @@ def upsert_field(self, namespace_name, upsert_log_analytics_field_details, **kwa def upsert_label(self, namespace_name, upsert_log_analytics_label_details, **kwargs): """ - Define or update a label. + Creates or updates a label that could be used to tag a log entry. You may optionally designate the label as a problem, and assign it a priority. You may also provide its related terms (aliases). To create a label, specify its display name. A name would be generated for the label. For subsequent calls to update the label, include the name attribute. :param str namespace_name: (required) @@ -13965,7 +16062,7 @@ def upsert_label(self, namespace_name, upsert_log_analytics_label_details, **kwa def upsert_parser(self, namespace_name, upsert_log_analytics_parser_details, **kwargs): """ - Define or update parser + Creates or updates a parser, which defines how fields are extracted from a log entry. :param str namespace_name: (required) @@ -14065,7 +16162,7 @@ def upsert_parser(self, namespace_name, upsert_log_analytics_parser_details, **k def upsert_source(self, namespace_name, upsert_log_analytics_source_details, **kwargs): """ - Define or update a source + Creates or updates a log source. You may also specify parsers, labels, extended fields etc., for the source. :param str namespace_name: (required) @@ -14075,10 +16172,12 @@ def upsert_source(self, namespace_name, upsert_log_analytics_source_details, **k Details for the new LoganSourceDetails. :param int create_like_source_id: (optional) - create like sourceId + The unique identifier of the source to use as the reference for a create like + operation. :param bool is_incremental: (optional) - is incremental + A flag indicating whether or not the update of a source is incremental or not. If incremental, + the name of the source must be specified. :param bool is_ignore_warning: (optional) is ignore warning @@ -14186,7 +16285,7 @@ def upsert_source(self, namespace_name, upsert_log_analytics_source_details, **k def validate_association_parameters(self, namespace_name, upsert_log_analytics_association_details, **kwargs): """ - association parameter validation + Checks if the passed in entities could be associated with the specified sources. The validation is performed to ensure that the entities have the relevant property values that are used in the corresponding source patterns. :param str namespace_name: (required) @@ -14207,7 +16306,7 @@ def validate_association_parameters(self, namespace_name, upsert_log_analytics_a Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - sort by field + The attribute used to sort the returned association parameters Allowed values are: "sourceDisplayName", "status" @@ -14410,7 +16509,7 @@ def validate_file(self, namespace_name, object_location, filename, **kwargs): def validate_source(self, namespace_name, upsert_log_analytics_source_details, **kwargs): """ - Pre-define or update a source + Checks if the specified input is a valid log source definition. :param str namespace_name: (required) @@ -14420,10 +16519,12 @@ def validate_source(self, namespace_name, upsert_log_analytics_source_details, * Details for the new LoganSourceDetails. :param int create_like_source_id: (optional) - create like sourceId + The unique identifier of the source to use as the reference for a create like + operation. :param bool is_incremental: (optional) - is incremental + A flag indicating whether or not the update of a source is incremental or not. If incremental, + the name of the source must be specified. :param bool is_ignore_warning: (optional) is ignore warning @@ -14522,7 +16623,7 @@ def validate_source(self, namespace_name, upsert_log_analytics_source_details, * def validate_source_extended_field_details(self, namespace_name, log_analytics_source, **kwargs): """ - test extended fields + Checks if the specified input contains valid extended field definitions against the provided example content. :param str namespace_name: (required) diff --git a/src/oci/log_analytics/log_analytics_client_composite_operations.py b/src/oci/log_analytics/log_analytics_client_composite_operations.py index cd695bf7f8..cdfb443b06 100644 --- a/src/oci/log_analytics/log_analytics_client_composite_operations.py +++ b/src/oci/log_analytics/log_analytics_client_composite_operations.py @@ -67,6 +67,47 @@ def append_lookup_data_and_wait_for_state(self, namespace_name, lookup_name, app except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_log_analytics_em_bridge_and_wait_for_state(self, namespace_name, create_log_analytics_em_bridge_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.create_log_analytics_em_bridge` and waits for the :py:class:`~oci.log_analytics.models.LogAnalyticsEmBridge` acted upon + to enter the given state(s). + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails create_log_analytics_em_bridge_details: (required) + Details for the enterprise manager bridge. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.log_analytics.models.LogAnalyticsEmBridge.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.log_analytics.LogAnalyticsClient.create_log_analytics_em_bridge` + + :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_log_analytics_em_bridge(namespace_name, create_log_analytics_em_bridge_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_log_analytics_em_bridge(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_log_analytics_entity_and_wait_for_state(self, namespace_name, create_log_analytics_entity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.create_log_analytics_entity` and waits for the :py:class:`~oci.log_analytics.models.LogAnalyticsEntity` acted upon @@ -280,6 +321,94 @@ def delete_lookup_and_wait_for_state(self, namespace_name, lookup_name, wait_for except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def disable_auto_association_and_wait_for_state(self, namespace_name, source_name, disable_auto_association_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.disable_auto_association` and waits for the :py:class:`~oci.log_analytics.models.WorkRequest` + to enter the given state(s). + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.DisableAutoAssociationDetails disable_auto_association_details: (required) + Details required to disable auto association for the log source. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.log_analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.log_analytics.LogAnalyticsClient.disable_auto_association` + + :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.disable_auto_association(namespace_name, source_name, disable_auto_association_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 enable_auto_association_and_wait_for_state(self, namespace_name, source_name, enable_auto_association_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.enable_auto_association` and waits for the :py:class:`~oci.log_analytics.models.WorkRequest` + to enter the given state(s). + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str source_name: (required) + The source name. + + :param oci.log_analytics.models.EnableAutoAssociationDetails enable_auto_association_details: (required) + Details required to enable auto association for the log source. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.log_analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.log_analytics.LogAnalyticsClient.enable_auto_association` + + :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.enable_auto_association(namespace_name, source_name, enable_auto_association_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 offboard_namespace_and_wait_for_state(self, namespace_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.offboard_namespace` and waits for the :py:class:`~oci.log_analytics.models.WorkRequest` @@ -604,6 +733,50 @@ def resume_scheduled_task_and_wait_for_state(self, namespace_name, scheduled_tas except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_log_analytics_em_bridge_and_wait_for_state(self, namespace_name, log_analytics_em_bridge_id, update_log_analytics_em_bridge_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.update_log_analytics_em_bridge` and waits for the :py:class:`~oci.log_analytics.models.LogAnalyticsEmBridge` acted upon + to enter the given state(s). + + :param str namespace_name: (required) + The Logging Analytics namespace used for the request. + + :param str log_analytics_em_bridge_id: (required) + The log analytics enterprise manager bridge OCID. + + :param oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails update_log_analytics_em_bridge_details: (required) + Log analytics enterprise manager 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.log_analytics.models.LogAnalyticsEmBridge.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.log_analytics.LogAnalyticsClient.update_log_analytics_em_bridge` + + :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_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, update_log_analytics_em_bridge_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_log_analytics_em_bridge(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_log_analytics_entity_and_wait_for_state(self, namespace_name, log_analytics_entity_id, update_log_analytics_entity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.log_analytics.LogAnalyticsClient.update_log_analytics_entity` and waits for the :py:class:`~oci.log_analytics.models.LogAnalyticsEntity` acted upon diff --git a/src/oci/log_analytics/models/__init__.py b/src/oci/log_analytics/models/__init__.py index 16a5124564..884898791d 100644 --- a/src/oci/log_analytics/models/__init__.py +++ b/src/oci/log_analytics/models/__init__.py @@ -14,11 +14,16 @@ from .add_fields_command_descriptor import AddFieldsCommandDescriptor from .archiving_configuration import ArchivingConfiguration from .argument import Argument +from .associable_entity import AssociableEntity +from .associable_entity_collection import AssociableEntityCollection from .association_summary_report import AssociationSummaryReport +from .auto_association_collection import AutoAssociationCollection +from .auto_association_state import AutoAssociationState from .auto_lookups import AutoLookups from .bottom_command_descriptor import BottomCommandDescriptor from .bucket_command_descriptor import BucketCommandDescriptor from .bucket_range import BucketRange +from .change_log_analytics_em_bridge_compartment_details import ChangeLogAnalyticsEmBridgeCompartmentDetails from .change_log_analytics_entity_compartment_details import ChangeLogAnalyticsEntityCompartmentDetails from .change_log_analytics_log_group_compartment_details import ChangeLogAnalyticsLogGroupCompartmentDetails from .change_log_analytics_object_collection_rule_compartment_details import ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails @@ -37,6 +42,7 @@ from .column_name_collection import ColumnNameCollection from .command_descriptor import CommandDescriptor from .create_acceleration_task_details import CreateAccelerationTaskDetails +from .create_log_analytics_em_bridge_details import CreateLogAnalyticsEmBridgeDetails from .create_log_analytics_entity_details import CreateLogAnalyticsEntityDetails from .create_log_analytics_entity_type_details import CreateLogAnalyticsEntityTypeDetails from .create_log_analytics_log_group_details import CreateLogAnalyticsLogGroupDetails @@ -44,14 +50,19 @@ from .create_scheduled_task_details import CreateScheduledTaskDetails from .create_standard_task_details import CreateStandardTaskDetails from .create_view_command_descriptor import CreateViewCommandDescriptor +from .creation_source import CreationSource from .cron_schedule import CronSchedule from .delete_command_descriptor import DeleteCommandDescriptor from .delete_log_analytics_association import DeleteLogAnalyticsAssociation from .delete_log_analytics_association_details import DeleteLogAnalyticsAssociationDetails from .delta_command_descriptor import DeltaCommandDescriptor from .demo_mode_command_descriptor import DemoModeCommandDescriptor +from .disable_auto_association_detail import DisableAutoAssociationDetail +from .disable_auto_association_details import DisableAutoAssociationDetails from .distinct_command_descriptor import DistinctCommandDescriptor from .efd_regex_result import EfdRegexResult +from .enable_auto_association_detail import EnableAutoAssociationDetail +from .enable_auto_association_details import EnableAutoAssociationDetails from .entity_type_property import EntityTypeProperty from .error_details import ErrorDetails from .estimate_purge_data_size_details import EstimatePurgeDataSizeDetails @@ -63,6 +74,8 @@ from .eval_command_descriptor import EvalCommandDescriptor from .event_stats_command_descriptor import EventStatsCommandDescriptor from .event_type import EventType +from .event_type_collection import EventTypeCollection +from .event_type_details import EventTypeDetails from .export_content import ExportContent from .export_details import ExportDetails from .extended_fields_validation_result import ExtendedFieldsValidationResult @@ -107,6 +120,10 @@ from .log_analytics_config_work_request_collection import LogAnalyticsConfigWorkRequestCollection from .log_analytics_config_work_request_payload import LogAnalyticsConfigWorkRequestPayload from .log_analytics_config_work_request_summary import LogAnalyticsConfigWorkRequestSummary +from .log_analytics_em_bridge import LogAnalyticsEmBridge +from .log_analytics_em_bridge_collection import LogAnalyticsEmBridgeCollection +from .log_analytics_em_bridge_summary import LogAnalyticsEmBridgeSummary +from .log_analytics_em_bridge_summary_report import LogAnalyticsEmBridgeSummaryReport from .log_analytics_entity import LogAnalyticsEntity from .log_analytics_entity_collection import LogAnalyticsEntityCollection from .log_analytics_entity_summary import LogAnalyticsEntitySummary @@ -172,8 +189,10 @@ from .log_analytics_warning import LogAnalyticsWarning from .log_analytics_warning_collection import LogAnalyticsWarningCollection from .log_group_summary_report import LogGroupSummaryReport +from .log_set_collection import LogSetCollection from .lookup_command_descriptor import LookupCommandDescriptor from .lookup_field import LookupField +from .lookup_summary_report import LookupSummaryReport from .macro_command_descriptor import MacroCommandDescriptor from .map_command_descriptor import MapCommandDescriptor from .match_info import MatchInfo @@ -243,6 +262,7 @@ from .top_command_descriptor import TopCommandDescriptor from .trend_column import TrendColumn from .ui_parser_test_metadata import UiParserTestMetadata +from .update_log_analytics_em_bridge_details import UpdateLogAnalyticsEmBridgeDetails from .update_log_analytics_entity_details import UpdateLogAnalyticsEntityDetails from .update_log_analytics_entity_type_details import UpdateLogAnalyticsEntityTypeDetails from .update_log_analytics_log_group_details import UpdateLogAnalyticsLogGroupDetails @@ -291,11 +311,16 @@ "AddFieldsCommandDescriptor": AddFieldsCommandDescriptor, "ArchivingConfiguration": ArchivingConfiguration, "Argument": Argument, + "AssociableEntity": AssociableEntity, + "AssociableEntityCollection": AssociableEntityCollection, "AssociationSummaryReport": AssociationSummaryReport, + "AutoAssociationCollection": AutoAssociationCollection, + "AutoAssociationState": AutoAssociationState, "AutoLookups": AutoLookups, "BottomCommandDescriptor": BottomCommandDescriptor, "BucketCommandDescriptor": BucketCommandDescriptor, "BucketRange": BucketRange, + "ChangeLogAnalyticsEmBridgeCompartmentDetails": ChangeLogAnalyticsEmBridgeCompartmentDetails, "ChangeLogAnalyticsEntityCompartmentDetails": ChangeLogAnalyticsEntityCompartmentDetails, "ChangeLogAnalyticsLogGroupCompartmentDetails": ChangeLogAnalyticsLogGroupCompartmentDetails, "ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails": ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails, @@ -314,6 +339,7 @@ "ColumnNameCollection": ColumnNameCollection, "CommandDescriptor": CommandDescriptor, "CreateAccelerationTaskDetails": CreateAccelerationTaskDetails, + "CreateLogAnalyticsEmBridgeDetails": CreateLogAnalyticsEmBridgeDetails, "CreateLogAnalyticsEntityDetails": CreateLogAnalyticsEntityDetails, "CreateLogAnalyticsEntityTypeDetails": CreateLogAnalyticsEntityTypeDetails, "CreateLogAnalyticsLogGroupDetails": CreateLogAnalyticsLogGroupDetails, @@ -321,14 +347,19 @@ "CreateScheduledTaskDetails": CreateScheduledTaskDetails, "CreateStandardTaskDetails": CreateStandardTaskDetails, "CreateViewCommandDescriptor": CreateViewCommandDescriptor, + "CreationSource": CreationSource, "CronSchedule": CronSchedule, "DeleteCommandDescriptor": DeleteCommandDescriptor, "DeleteLogAnalyticsAssociation": DeleteLogAnalyticsAssociation, "DeleteLogAnalyticsAssociationDetails": DeleteLogAnalyticsAssociationDetails, "DeltaCommandDescriptor": DeltaCommandDescriptor, "DemoModeCommandDescriptor": DemoModeCommandDescriptor, + "DisableAutoAssociationDetail": DisableAutoAssociationDetail, + "DisableAutoAssociationDetails": DisableAutoAssociationDetails, "DistinctCommandDescriptor": DistinctCommandDescriptor, "EfdRegexResult": EfdRegexResult, + "EnableAutoAssociationDetail": EnableAutoAssociationDetail, + "EnableAutoAssociationDetails": EnableAutoAssociationDetails, "EntityTypeProperty": EntityTypeProperty, "ErrorDetails": ErrorDetails, "EstimatePurgeDataSizeDetails": EstimatePurgeDataSizeDetails, @@ -340,6 +371,8 @@ "EvalCommandDescriptor": EvalCommandDescriptor, "EventStatsCommandDescriptor": EventStatsCommandDescriptor, "EventType": EventType, + "EventTypeCollection": EventTypeCollection, + "EventTypeDetails": EventTypeDetails, "ExportContent": ExportContent, "ExportDetails": ExportDetails, "ExtendedFieldsValidationResult": ExtendedFieldsValidationResult, @@ -384,6 +417,10 @@ "LogAnalyticsConfigWorkRequestCollection": LogAnalyticsConfigWorkRequestCollection, "LogAnalyticsConfigWorkRequestPayload": LogAnalyticsConfigWorkRequestPayload, "LogAnalyticsConfigWorkRequestSummary": LogAnalyticsConfigWorkRequestSummary, + "LogAnalyticsEmBridge": LogAnalyticsEmBridge, + "LogAnalyticsEmBridgeCollection": LogAnalyticsEmBridgeCollection, + "LogAnalyticsEmBridgeSummary": LogAnalyticsEmBridgeSummary, + "LogAnalyticsEmBridgeSummaryReport": LogAnalyticsEmBridgeSummaryReport, "LogAnalyticsEntity": LogAnalyticsEntity, "LogAnalyticsEntityCollection": LogAnalyticsEntityCollection, "LogAnalyticsEntitySummary": LogAnalyticsEntitySummary, @@ -449,8 +486,10 @@ "LogAnalyticsWarning": LogAnalyticsWarning, "LogAnalyticsWarningCollection": LogAnalyticsWarningCollection, "LogGroupSummaryReport": LogGroupSummaryReport, + "LogSetCollection": LogSetCollection, "LookupCommandDescriptor": LookupCommandDescriptor, "LookupField": LookupField, + "LookupSummaryReport": LookupSummaryReport, "MacroCommandDescriptor": MacroCommandDescriptor, "MapCommandDescriptor": MapCommandDescriptor, "MatchInfo": MatchInfo, @@ -520,6 +559,7 @@ "TopCommandDescriptor": TopCommandDescriptor, "TrendColumn": TrendColumn, "UiParserTestMetadata": UiParserTestMetadata, + "UpdateLogAnalyticsEmBridgeDetails": UpdateLogAnalyticsEmBridgeDetails, "UpdateLogAnalyticsEntityDetails": UpdateLogAnalyticsEntityDetails, "UpdateLogAnalyticsEntityTypeDetails": UpdateLogAnalyticsEntityTypeDetails, "UpdateLogAnalyticsLogGroupDetails": UpdateLogAnalyticsLogGroupDetails, diff --git a/src/oci/log_analytics/models/abstract_parser_test_result_log_entry.py b/src/oci/log_analytics/models/abstract_parser_test_result_log_entry.py index 636ce6ef51..6ac9218491 100644 --- a/src/oci/log_analytics/models/abstract_parser_test_result_log_entry.py +++ b/src/oci/log_analytics/models/abstract_parser_test_result_log_entry.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def extra_info_attributes(self): """ Gets the extra_info_attributes of this AbstractParserTestResultLogEntry. - extra info attributes + Extra information attributes. :return: The extra_info_attributes of this AbstractParserTestResultLogEntry. @@ -91,7 +91,7 @@ def extra_info_attributes(self): def extra_info_attributes(self, extra_info_attributes): """ Sets the extra_info_attributes of this AbstractParserTestResultLogEntry. - extra info attributes + Extra information attributes. :param extra_info_attributes: The extra_info_attributes of this AbstractParserTestResultLogEntry. @@ -103,7 +103,7 @@ def extra_info_attributes(self, extra_info_attributes): def field_name_value_map(self): """ Gets the field_name_value_map of this AbstractParserTestResultLogEntry. - field name value map + The field name value map. :return: The field_name_value_map of this AbstractParserTestResultLogEntry. @@ -115,7 +115,7 @@ def field_name_value_map(self): def field_name_value_map(self, field_name_value_map): """ Sets the field_name_value_map of this AbstractParserTestResultLogEntry. - field name value map + The field name value map. :param field_name_value_map: The field_name_value_map of this AbstractParserTestResultLogEntry. @@ -127,7 +127,7 @@ def field_name_value_map(self, field_name_value_map): def field_position_value_map(self): """ Gets the field_position_value_map of this AbstractParserTestResultLogEntry. - field position value map + The field position value map. :return: The field_position_value_map of this AbstractParserTestResultLogEntry. @@ -139,7 +139,7 @@ def field_position_value_map(self): def field_position_value_map(self, field_position_value_map): """ Sets the field_position_value_map of this AbstractParserTestResultLogEntry. - field position value map + The field position value map. :param field_position_value_map: The field_position_value_map of this AbstractParserTestResultLogEntry. @@ -151,7 +151,7 @@ def field_position_value_map(self, field_position_value_map): def fields(self): """ Gets the fields of this AbstractParserTestResultLogEntry. - fields + The parser fields. :return: The fields of this AbstractParserTestResultLogEntry. @@ -163,7 +163,7 @@ def fields(self): def fields(self, fields): """ Sets the fields of this AbstractParserTestResultLogEntry. - fields + The parser fields. :param fields: The fields of this AbstractParserTestResultLogEntry. @@ -175,7 +175,7 @@ def fields(self, fields): def log_entry(self): """ Gets the log_entry of this AbstractParserTestResultLogEntry. - log entry + The log entry. :return: The log_entry of this AbstractParserTestResultLogEntry. @@ -187,7 +187,7 @@ def log_entry(self): def log_entry(self, log_entry): """ Sets the log_entry of this AbstractParserTestResultLogEntry. - log entry + The log entry. :param log_entry: The log_entry of this AbstractParserTestResultLogEntry. @@ -199,7 +199,7 @@ def log_entry(self, log_entry): def match_status(self): """ Gets the match_status of this AbstractParserTestResultLogEntry. - match status + The match status. :return: The match_status of this AbstractParserTestResultLogEntry. @@ -211,7 +211,7 @@ def match_status(self): def match_status(self, match_status): """ Sets the match_status of this AbstractParserTestResultLogEntry. - match status + The match status. :param match_status: The match_status of this AbstractParserTestResultLogEntry. @@ -223,7 +223,7 @@ def match_status(self, match_status): def match_status_description(self): """ Gets the match_status_description of this AbstractParserTestResultLogEntry. - match status description + The match status description. :return: The match_status_description of this AbstractParserTestResultLogEntry. @@ -235,7 +235,7 @@ def match_status_description(self): def match_status_description(self, match_status_description): """ Sets the match_status_description of this AbstractParserTestResultLogEntry. - match status description + The match status description. :param match_status_description: The match_status_description of this AbstractParserTestResultLogEntry. diff --git a/src/oci/log_analytics/models/abstract_parser_test_result_log_line.py b/src/oci/log_analytics/models/abstract_parser_test_result_log_line.py index b45ecb6e11..6320661d6f 100644 --- a/src/oci/log_analytics/models/abstract_parser_test_result_log_line.py +++ b/src/oci/log_analytics/models/abstract_parser_test_result_log_line.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def original_log_line(self): """ Gets the original_log_line of this AbstractParserTestResultLogLine. - original log line + The original log line. :return: The original_log_line of this AbstractParserTestResultLogLine. @@ -56,7 +56,7 @@ def original_log_line(self): def original_log_line(self, original_log_line): """ Sets the original_log_line of this AbstractParserTestResultLogLine. - original log line + The original log line. :param original_log_line: The original_log_line of this AbstractParserTestResultLogLine. @@ -68,7 +68,7 @@ def original_log_line(self, original_log_line): def pre_processed_log_line(self): """ Gets the pre_processed_log_line of this AbstractParserTestResultLogLine. - pre-processed log line + The pre-processed log line. :return: The pre_processed_log_line of this AbstractParserTestResultLogLine. @@ -80,7 +80,7 @@ def pre_processed_log_line(self): def pre_processed_log_line(self, pre_processed_log_line): """ Sets the pre_processed_log_line of this AbstractParserTestResultLogLine. - pre-processed log line + The pre-processed log line. :param pre_processed_log_line: The pre_processed_log_line of this AbstractParserTestResultLogLine. diff --git a/src/oci/log_analytics/models/associable_entity.py b/src/oci/log_analytics/models/associable_entity.py new file mode 100644 index 0000000000..b1417c4b16 --- /dev/null +++ b/src/oci/log_analytics/models/associable_entity.py @@ -0,0 +1,303 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AssociableEntity(object): + """ + Entity details including whether or not it is eligible for association with the source. + """ + + #: A constant which can be used with the eligibility_status property of a AssociableEntity. + #: This constant has a value of "ELIGIBLE" + ELIGIBILITY_STATUS_ELIGIBLE = "ELIGIBLE" + + #: A constant which can be used with the eligibility_status property of a AssociableEntity. + #: This constant has a value of "INELIGIBLE" + ELIGIBILITY_STATUS_INELIGIBLE = "INELIGIBLE" + + def __init__(self, **kwargs): + """ + Initializes a new AssociableEntity object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_id: + The value to assign to the entity_id property of this AssociableEntity. + :type entity_id: str + + :param entity_name: + The value to assign to the entity_name property of this AssociableEntity. + :type entity_name: str + + :param entity_type_name: + The value to assign to the entity_type_name property of this AssociableEntity. + :type entity_type_name: str + + :param entity_type_display_name: + The value to assign to the entity_type_display_name property of this AssociableEntity. + :type entity_type_display_name: str + + :param host: + The value to assign to the host property of this AssociableEntity. + :type host: str + + :param agent_id: + The value to assign to the agent_id property of this AssociableEntity. + :type agent_id: str + + :param eligibility_status: + The value to assign to the eligibility_status property of this AssociableEntity. + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type eligibility_status: str + + :param ineligibility_details: + The value to assign to the ineligibility_details property of this AssociableEntity. + :type ineligibility_details: str + + """ + self.swagger_types = { + 'entity_id': 'str', + 'entity_name': 'str', + 'entity_type_name': 'str', + 'entity_type_display_name': 'str', + 'host': 'str', + 'agent_id': 'str', + 'eligibility_status': 'str', + 'ineligibility_details': 'str' + } + + self.attribute_map = { + 'entity_id': 'entityId', + 'entity_name': 'entityName', + 'entity_type_name': 'entityTypeName', + 'entity_type_display_name': 'entityTypeDisplayName', + 'host': 'host', + 'agent_id': 'agentId', + 'eligibility_status': 'eligibilityStatus', + 'ineligibility_details': 'ineligibilityDetails' + } + + self._entity_id = None + self._entity_name = None + self._entity_type_name = None + self._entity_type_display_name = None + self._host = None + self._agent_id = None + self._eligibility_status = None + self._ineligibility_details = None + + @property + def entity_id(self): + """ + Gets the entity_id of this AssociableEntity. + The entity OCID. + + + :return: The entity_id of this AssociableEntity. + :rtype: str + """ + return self._entity_id + + @entity_id.setter + def entity_id(self, entity_id): + """ + Sets the entity_id of this AssociableEntity. + The entity OCID. + + + :param entity_id: The entity_id of this AssociableEntity. + :type: str + """ + self._entity_id = entity_id + + @property + def entity_name(self): + """ + Gets the entity_name of this AssociableEntity. + The name of the entity. + + + :return: The entity_name of this AssociableEntity. + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """ + Sets the entity_name of this AssociableEntity. + The name of the entity. + + + :param entity_name: The entity_name of this AssociableEntity. + :type: str + """ + self._entity_name = entity_name + + @property + def entity_type_name(self): + """ + Gets the entity_type_name of this AssociableEntity. + The type name of the entity. + + + :return: The entity_type_name of this AssociableEntity. + :rtype: str + """ + return self._entity_type_name + + @entity_type_name.setter + def entity_type_name(self, entity_type_name): + """ + Sets the entity_type_name of this AssociableEntity. + The type name of the entity. + + + :param entity_type_name: The entity_type_name of this AssociableEntity. + :type: str + """ + self._entity_type_name = entity_type_name + + @property + def entity_type_display_name(self): + """ + Gets the entity_type_display_name of this AssociableEntity. + The display name of the entity type. + + + :return: The entity_type_display_name of this AssociableEntity. + :rtype: str + """ + return self._entity_type_display_name + + @entity_type_display_name.setter + def entity_type_display_name(self, entity_type_display_name): + """ + Sets the entity_type_display_name of this AssociableEntity. + The display name of the entity type. + + + :param entity_type_display_name: The entity_type_display_name of this AssociableEntity. + :type: str + """ + self._entity_type_display_name = entity_type_display_name + + @property + def host(self): + """ + Gets the host of this AssociableEntity. + The entity host. + + + :return: The host of this AssociableEntity. + :rtype: str + """ + return self._host + + @host.setter + def host(self, host): + """ + Sets the host of this AssociableEntity. + The entity host. + + + :param host: The host of this AssociableEntity. + :type: str + """ + self._host = host + + @property + def agent_id(self): + """ + Gets the agent_id of this AssociableEntity. + The OCID of the Management Agent. + + + :return: The agent_id of this AssociableEntity. + :rtype: str + """ + return self._agent_id + + @agent_id.setter + def agent_id(self, agent_id): + """ + Sets the agent_id of this AssociableEntity. + The OCID of the Management Agent. + + + :param agent_id: The agent_id of this AssociableEntity. + :type: str + """ + self._agent_id = agent_id + + @property + def eligibility_status(self): + """ + Gets the eligibility_status of this AssociableEntity. + This field indicates whether the entity is (in)eligible to be associated with this source. + + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The eligibility_status of this AssociableEntity. + :rtype: str + """ + return self._eligibility_status + + @eligibility_status.setter + def eligibility_status(self, eligibility_status): + """ + Sets the eligibility_status of this AssociableEntity. + This field indicates whether the entity is (in)eligible to be associated with this source. + + + :param eligibility_status: The eligibility_status of this AssociableEntity. + :type: str + """ + allowed_values = ["ELIGIBLE", "INELIGIBLE"] + if not value_allowed_none_or_none_sentinel(eligibility_status, allowed_values): + eligibility_status = 'UNKNOWN_ENUM_VALUE' + self._eligibility_status = eligibility_status + + @property + def ineligibility_details(self): + """ + Gets the ineligibility_details of this AssociableEntity. + The reason the entity is not eligible for association. + + + :return: The ineligibility_details of this AssociableEntity. + :rtype: str + """ + return self._ineligibility_details + + @ineligibility_details.setter + def ineligibility_details(self, ineligibility_details): + """ + Sets the ineligibility_details of this AssociableEntity. + The reason the entity is not eligible for association. + + + :param ineligibility_details: The ineligibility_details of this AssociableEntity. + :type: str + """ + self._ineligibility_details = ineligibility_details + + 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/log_analytics/models/associable_entity_collection.py b/src/oci/log_analytics/models/associable_entity_collection.py new file mode 100644 index 0000000000..bbb9bcf30d --- /dev/null +++ b/src/oci/log_analytics/models/associable_entity_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AssociableEntityCollection(object): + """ + The collection of entities that are eligible or ineligible to be associated to the source. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AssociableEntityCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this AssociableEntityCollection. + :type items: list[oci.log_analytics.models.AssociableEntity] + + """ + self.swagger_types = { + 'items': 'list[AssociableEntity]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this AssociableEntityCollection. + An array of entities. + + + :return: The items of this AssociableEntityCollection. + :rtype: list[oci.log_analytics.models.AssociableEntity] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AssociableEntityCollection. + An array of entities. + + + :param items: The items of this AssociableEntityCollection. + :type: list[oci.log_analytics.models.AssociableEntity] + """ + self._items = items + + 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/log_analytics/models/association_summary_report.py b/src/oci/log_analytics/models/association_summary_report.py index 7fc48f8649..bdf65dd872 100644 --- a/src/oci/log_analytics/models/association_summary_report.py +++ b/src/oci/log_analytics/models/association_summary_report.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def association_count(self): """ Gets the association_count of this AssociationSummaryReport. - association count + The association count. :return: The association_count of this AssociationSummaryReport. @@ -49,7 +49,7 @@ def association_count(self): def association_count(self, association_count): """ Sets the association_count of this AssociationSummaryReport. - association count + The association count. :param association_count: The association_count of this AssociationSummaryReport. diff --git a/src/oci/log_analytics/models/auto_association_collection.py b/src/oci/log_analytics/models/auto_association_collection.py new file mode 100644 index 0000000000..962fefe6c6 --- /dev/null +++ b/src/oci/log_analytics/models/auto_association_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AutoAssociationCollection(object): + """ + Auto association details of the source. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AutoAssociationCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this AutoAssociationCollection. + :type items: list[oci.log_analytics.models.AutoAssociationState] + + """ + self.swagger_types = { + 'items': 'list[AutoAssociationState]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this AutoAssociationCollection. + Auto association details of the source. + + + :return: The items of this AutoAssociationCollection. + :rtype: list[oci.log_analytics.models.AutoAssociationState] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AutoAssociationCollection. + Auto association details of the source. + + + :param items: The items of this AutoAssociationCollection. + :type: list[oci.log_analytics.models.AutoAssociationState] + """ + self._items = items + + 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/log_analytics/models/auto_association_state.py b/src/oci/log_analytics/models/auto_association_state.py new file mode 100644 index 0000000000..4790ebdd10 --- /dev/null +++ b/src/oci/log_analytics/models/auto_association_state.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AutoAssociationState(object): + """ + Auto association state of the source. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AutoAssociationState object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_enabled: + The value to assign to the is_enabled property of this AutoAssociationState. + :type is_enabled: bool + + :param log_group_id: + The value to assign to the log_group_id property of this AutoAssociationState. + :type log_group_id: str + + """ + self.swagger_types = { + 'is_enabled': 'bool', + 'log_group_id': 'str' + } + + self.attribute_map = { + 'is_enabled': 'isEnabled', + 'log_group_id': 'logGroupId' + } + + self._is_enabled = None + self._log_group_id = None + + @property + def is_enabled(self): + """ + Gets the is_enabled of this AutoAssociationState. + A flag indicating whether or not auto association is enabled. + + + :return: The is_enabled of this AutoAssociationState. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this AutoAssociationState. + A flag indicating whether or not auto association is enabled. + + + :param is_enabled: The is_enabled of this AutoAssociationState. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def log_group_id(self): + """ + Gets the log_group_id of this AutoAssociationState. + The unique identifier of the log group to use for auto association. + + + :return: The log_group_id of this AutoAssociationState. + :rtype: str + """ + return self._log_group_id + + @log_group_id.setter + def log_group_id(self, log_group_id): + """ + Sets the log_group_id of this AutoAssociationState. + The unique identifier of the log group to use for auto association. + + + :param log_group_id: The log_group_id of this AutoAssociationState. + :type: str + """ + self._log_group_id = log_group_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/log_analytics/models/auto_lookups.py b/src/oci/log_analytics/models/auto_lookups.py index c1e991d4ea..10b101164e 100644 --- a/src/oci/log_analytics/models/auto_lookups.py +++ b/src/oci/log_analytics/models/auto_lookups.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def canonical_link(self): """ Gets the canonical_link of this AutoLookups. - canonical link + The canonical link. :return: The canonical_link of this AutoLookups. @@ -56,7 +56,7 @@ def canonical_link(self): def canonical_link(self, canonical_link): """ Sets the canonical_link of this AutoLookups. - canonical link + The canonical link. :param canonical_link: The canonical_link of this AutoLookups. @@ -68,7 +68,7 @@ def canonical_link(self, canonical_link): def total_count(self): """ Gets the total_count of this AutoLookups. - total count + The total count. :return: The total_count of this AutoLookups. @@ -80,7 +80,7 @@ def total_count(self): def total_count(self, total_count): """ Sets the total_count of this AutoLookups. - total count + The total count. :param total_count: The total_count of this AutoLookups. diff --git a/src/oci/log_analytics/models/change_log_analytics_em_bridge_compartment_details.py b/src/oci/log_analytics/models/change_log_analytics_em_bridge_compartment_details.py new file mode 100644 index 0000000000..d91b76de60 --- /dev/null +++ b/src/oci/log_analytics/models/change_log_analytics_em_bridge_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeLogAnalyticsEmBridgeCompartmentDetails(object): + """ + Log analytics enterprise manager bridge compartment to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeLogAnalyticsEmBridgeCompartmentDetails 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 ChangeLogAnalyticsEmBridgeCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeLogAnalyticsEmBridgeCompartmentDetails. + The OCID of the compartment where the log analytics entity should be moved. + + + :return: The compartment_id of this ChangeLogAnalyticsEmBridgeCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeLogAnalyticsEmBridgeCompartmentDetails. + The OCID of the compartment where the log analytics entity should be moved. + + + :param compartment_id: The compartment_id of this ChangeLogAnalyticsEmBridgeCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/log_analytics/models/change_log_analytics_log_group_compartment_details.py b/src/oci/log_analytics/models/change_log_analytics_log_group_compartment_details.py index d30e8698ed..44c9ef1dd5 100644 --- a/src/oci/log_analytics/models/change_log_analytics_log_group_compartment_details.py +++ b/src/oci/log_analytics/models/change_log_analytics_log_group_compartment_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ChangeLogAnalyticsLogGroupCompartmentDetails(object): """ - The information to be updated. + The information required to change a log group compartment. """ def __init__(self, **kwargs): diff --git a/src/oci/log_analytics/models/column_name.py b/src/oci/log_analytics/models/column_name.py index 38e388d1b4..da92a8c99e 100644 --- a/src/oci/log_analytics/models/column_name.py +++ b/src/oci/log_analytics/models/column_name.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def name(self): """ Gets the name of this ColumnName. - column name + The column name from a SQL query. :return: The name of this ColumnName. @@ -49,7 +49,7 @@ def name(self): def name(self, name): """ Sets the name of this ColumnName. - column name + The column name from a SQL query. :param name: The name of this ColumnName. diff --git a/src/oci/log_analytics/models/column_name_collection.py b/src/oci/log_analytics/models/column_name_collection.py index fbdc9e256d..60e9072a1a 100644 --- a/src/oci/log_analytics/models/column_name_collection.py +++ b/src/oci/log_analytics/models/column_name_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this ColumnNameCollection. - list of column names + A list of SQL query column names. :return: The items of this ColumnNameCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this ColumnNameCollection. - list of column names + A list of SQL query column names. :param items: The items of this ColumnNameCollection. diff --git a/src/oci/log_analytics/models/create_log_analytics_em_bridge_details.py b/src/oci/log_analytics/models/create_log_analytics_em_bridge_details.py new file mode 100644 index 0000000000..959b0c3636 --- /dev/null +++ b/src/oci/log_analytics/models/create_log_analytics_em_bridge_details.py @@ -0,0 +1,264 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateLogAnalyticsEmBridgeDetails(object): + """ + Details for a new enterprise manager bridge to be added. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateLogAnalyticsEmBridgeDetails 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 CreateLogAnalyticsEmBridgeDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateLogAnalyticsEmBridgeDetails. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateLogAnalyticsEmBridgeDetails. + :type compartment_id: str + + :param em_entities_compartment_id: + The value to assign to the em_entities_compartment_id property of this CreateLogAnalyticsEmBridgeDetails. + :type em_entities_compartment_id: str + + :param bucket_name: + The value to assign to the bucket_name property of this CreateLogAnalyticsEmBridgeDetails. + :type bucket_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateLogAnalyticsEmBridgeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateLogAnalyticsEmBridgeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'em_entities_compartment_id': 'str', + 'bucket_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'em_entities_compartment_id': 'emEntitiesCompartmentId', + 'bucket_name': 'bucketName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._compartment_id = None + self._em_entities_compartment_id = None + self._bucket_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateLogAnalyticsEmBridgeDetails. + Log analytics enterprise manager bridge display name. + + + :return: The display_name of this CreateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateLogAnalyticsEmBridgeDetails. + Log analytics enterprise manager bridge display name. + + + :param display_name: The display_name of this CreateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this CreateLogAnalyticsEmBridgeDetails. + A description for log analytics enterprise manager bridge. + + + :return: The description of this CreateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateLogAnalyticsEmBridgeDetails. + A description for log analytics enterprise manager bridge. + + + :param description: The description of this CreateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateLogAnalyticsEmBridgeDetails. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateLogAnalyticsEmBridgeDetails. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def em_entities_compartment_id(self): + """ + **[Required]** Gets the em_entities_compartment_id of this CreateLogAnalyticsEmBridgeDetails. + Compartment for entities created from enterprise manager. + + + :return: The em_entities_compartment_id of this CreateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._em_entities_compartment_id + + @em_entities_compartment_id.setter + def em_entities_compartment_id(self, em_entities_compartment_id): + """ + Sets the em_entities_compartment_id of this CreateLogAnalyticsEmBridgeDetails. + Compartment for entities created from enterprise manager. + + + :param em_entities_compartment_id: The em_entities_compartment_id of this CreateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._em_entities_compartment_id = em_entities_compartment_id + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this CreateLogAnalyticsEmBridgeDetails. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :return: The bucket_name of this CreateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this CreateLogAnalyticsEmBridgeDetails. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :param bucket_name: The bucket_name of this CreateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._bucket_name = bucket_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateLogAnalyticsEmBridgeDetails. + 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 CreateLogAnalyticsEmBridgeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateLogAnalyticsEmBridgeDetails. + 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 CreateLogAnalyticsEmBridgeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateLogAnalyticsEmBridgeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateLogAnalyticsEmBridgeDetails. + :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 CreateLogAnalyticsEmBridgeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateLogAnalyticsEmBridgeDetails. + :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/log_analytics/models/create_log_analytics_object_collection_rule_details.py b/src/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.py index c14ca3e50d..f0bb6083f8 100644 --- a/src/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.py +++ b/src/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.py @@ -496,7 +496,7 @@ def overrides(self): """ Gets the overrides of this CreateLogAnalyticsObjectCollectionRuleDetails. The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. - Supported propeties for override are - logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". @@ -510,7 +510,7 @@ def overrides(self, overrides): """ Sets the overrides of this CreateLogAnalyticsObjectCollectionRuleDetails. The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. - Supported propeties for override are - logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". diff --git a/src/oci/log_analytics/models/creation_source.py b/src/oci/log_analytics/models/creation_source.py new file mode 100644 index 0000000000..105e56755b --- /dev/null +++ b/src/oci/log_analytics/models/creation_source.py @@ -0,0 +1,125 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreationSource(object): + """ + Details for auto-created entity. + """ + + #: A constant which can be used with the type property of a CreationSource. + #: This constant has a value of "EM_BRIDGE" + TYPE_EM_BRIDGE = "EM_BRIDGE" + + #: A constant which can be used with the type property of a CreationSource. + #: This constant has a value of "SERVICE_CONNECTOR_HUB" + TYPE_SERVICE_CONNECTOR_HUB = "SERVICE_CONNECTOR_HUB" + + #: A constant which can be used with the type property of a CreationSource. + #: This constant has a value of "NONE" + TYPE_NONE = "NONE" + + def __init__(self, **kwargs): + """ + Initializes a new CreationSource object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this CreationSource. + Allowed values for this property are: "EM_BRIDGE", "SERVICE_CONNECTOR_HUB", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param details: + The value to assign to the details property of this CreationSource. + :type details: str + + """ + self.swagger_types = { + 'type': 'str', + 'details': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'details': 'details' + } + + self._type = None + self._details = None + + @property + def type(self): + """ + Gets the type of this CreationSource. + Source that auto-created the entity. + + Allowed values for this property are: "EM_BRIDGE", "SERVICE_CONNECTOR_HUB", "NONE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this CreationSource. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this CreationSource. + Source that auto-created the entity. + + + :param type: The type of this CreationSource. + :type: str + """ + allowed_values = ["EM_BRIDGE", "SERVICE_CONNECTOR_HUB", "NONE"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def details(self): + """ + Gets the details of this CreationSource. + This will provide additional details for source of auto-creation. For example, if entity is auto-created + by enterprise manager bridge, this field provides additional detail on enterprise manager that contributed + to the entity auto-creation. + + + :return: The details of this CreationSource. + :rtype: str + """ + return self._details + + @details.setter + def details(self, details): + """ + Sets the details of this CreationSource. + This will provide additional details for source of auto-creation. For example, if entity is auto-created + by enterprise manager bridge, this field provides additional detail on enterprise manager that contributed + to the entity auto-creation. + + + :param details: The details of this CreationSource. + :type: str + """ + self._details = details + + 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/log_analytics/models/delete_log_analytics_association.py b/src/oci/log_analytics/models/delete_log_analytics_association.py index d2adfd5c6b..97cb118db4 100644 --- a/src/oci/log_analytics/models/delete_log_analytics_association.py +++ b/src/oci/log_analytics/models/delete_log_analytics_association.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def agent_id(self): """ Gets the agent_id of this DeleteLogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :return: The agent_id of this DeleteLogAnalyticsAssociation. @@ -91,7 +91,7 @@ def agent_id(self): def agent_id(self, agent_id): """ Sets the agent_id of this DeleteLogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :param agent_id: The agent_id of this DeleteLogAnalyticsAssociation. @@ -103,7 +103,7 @@ def agent_id(self, agent_id): def source_name(self): """ Gets the source_name of this DeleteLogAnalyticsAssociation. - source name + The source name. :return: The source_name of this DeleteLogAnalyticsAssociation. @@ -115,7 +115,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this DeleteLogAnalyticsAssociation. - source name + The source name. :param source_name: The source_name of this DeleteLogAnalyticsAssociation. @@ -127,7 +127,7 @@ def source_name(self, source_name): def source_type_name(self): """ Gets the source_type_name of this DeleteLogAnalyticsAssociation. - source type internal name + The source type internal name. :return: The source_type_name of this DeleteLogAnalyticsAssociation. @@ -139,7 +139,7 @@ def source_type_name(self): def source_type_name(self, source_type_name): """ Sets the source_type_name of this DeleteLogAnalyticsAssociation. - source type internal name + The source type internal name. :param source_type_name: The source_type_name of this DeleteLogAnalyticsAssociation. @@ -151,7 +151,7 @@ def source_type_name(self, source_type_name): def entity_id(self): """ Gets the entity_id of this DeleteLogAnalyticsAssociation. - entity GUID + The entity unique identifier. :return: The entity_id of this DeleteLogAnalyticsAssociation. @@ -163,7 +163,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this DeleteLogAnalyticsAssociation. - entity GUID + The entity unique identifier. :param entity_id: The entity_id of this DeleteLogAnalyticsAssociation. @@ -175,7 +175,7 @@ def entity_id(self, entity_id): def entity_type_name(self): """ Gets the entity_type_name of this DeleteLogAnalyticsAssociation. - entity type internal name + The entity type internal name. :return: The entity_type_name of this DeleteLogAnalyticsAssociation. @@ -187,7 +187,7 @@ def entity_type_name(self): def entity_type_name(self, entity_type_name): """ Sets the entity_type_name of this DeleteLogAnalyticsAssociation. - entity type internal name + The entity type internal name. :param entity_type_name: The entity_type_name of this DeleteLogAnalyticsAssociation. @@ -199,7 +199,7 @@ def entity_type_name(self, entity_type_name): def host(self): """ Gets the host of this DeleteLogAnalyticsAssociation. - host name + The host name. :return: The host of this DeleteLogAnalyticsAssociation. @@ -211,7 +211,7 @@ def host(self): def host(self, host): """ Sets the host of this DeleteLogAnalyticsAssociation. - host name + The host name. :param host: The host of this DeleteLogAnalyticsAssociation. @@ -223,7 +223,7 @@ def host(self, host): def log_group_id(self): """ Gets the log_group_id of this DeleteLogAnalyticsAssociation. - log group ocid + The log group unique identifier. :return: The log_group_id of this DeleteLogAnalyticsAssociation. @@ -235,7 +235,7 @@ def log_group_id(self): def log_group_id(self, log_group_id): """ Sets the log_group_id of this DeleteLogAnalyticsAssociation. - log group ocid + The log group unique identifier. :param log_group_id: The log_group_id of this DeleteLogAnalyticsAssociation. diff --git a/src/oci/log_analytics/models/delete_log_analytics_association_details.py b/src/oci/log_analytics/models/delete_log_analytics_association_details.py index 9bcc217f32..85245120ec 100644 --- a/src/oci/log_analytics/models/delete_log_analytics_association_details.py +++ b/src/oci/log_analytics/models/delete_log_analytics_association_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeleteLogAnalyticsAssociationDetails(object): """ - DeleteLogAnalyticsAssociationDetails + The information required to delete a list of associations. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ Gets the compartment_id of this DeleteLogAnalyticsAssociationDetails. - compartmentId + The compartment ID :return: The compartment_id of this DeleteLogAnalyticsAssociationDetails. @@ -56,7 +56,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DeleteLogAnalyticsAssociationDetails. - compartmentId + The compartment ID :param compartment_id: The compartment_id of this DeleteLogAnalyticsAssociationDetails. @@ -68,7 +68,7 @@ def compartment_id(self, compartment_id): def items(self): """ Gets the items of this DeleteLogAnalyticsAssociationDetails. - list of rule entity association details + The information required to delete an association. :return: The items of this DeleteLogAnalyticsAssociationDetails. @@ -80,7 +80,7 @@ def items(self): def items(self, items): """ Sets the items of this DeleteLogAnalyticsAssociationDetails. - list of rule entity association details + The information required to delete an association. :param items: The items of this DeleteLogAnalyticsAssociationDetails. diff --git a/src/oci/log_analytics/models/disable_auto_association_detail.py b/src/oci/log_analytics/models/disable_auto_association_detail.py new file mode 100644 index 0000000000..b6642e3032 --- /dev/null +++ b/src/oci/log_analytics/models/disable_auto_association_detail.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DisableAutoAssociationDetail(object): + """ + The information required to disable log source auto-association. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DisableAutoAssociationDetail object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param delete_existing_associations: + The value to assign to the delete_existing_associations property of this DisableAutoAssociationDetail. + :type delete_existing_associations: bool + + """ + self.swagger_types = { + 'delete_existing_associations': 'bool' + } + + self.attribute_map = { + 'delete_existing_associations': 'deleteExistingAssociations' + } + + self._delete_existing_associations = None + + @property + def delete_existing_associations(self): + """ + Gets the delete_existing_associations of this DisableAutoAssociationDetail. + A flag indicating whether or not to delete all the existing associations of the log source. + + + :return: The delete_existing_associations of this DisableAutoAssociationDetail. + :rtype: bool + """ + return self._delete_existing_associations + + @delete_existing_associations.setter + def delete_existing_associations(self, delete_existing_associations): + """ + Sets the delete_existing_associations of this DisableAutoAssociationDetail. + A flag indicating whether or not to delete all the existing associations of the log source. + + + :param delete_existing_associations: The delete_existing_associations of this DisableAutoAssociationDetail. + :type: bool + """ + self._delete_existing_associations = delete_existing_associations + + 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/log_analytics/models/disable_auto_association_details.py b/src/oci/log_analytics/models/disable_auto_association_details.py new file mode 100644 index 0000000000..fd3c281e54 --- /dev/null +++ b/src/oci/log_analytics/models/disable_auto_association_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DisableAutoAssociationDetails(object): + """ + The information required to disable log source auto-association. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DisableAutoAssociationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this DisableAutoAssociationDetails. + :type items: list[oci.log_analytics.models.DisableAutoAssociationDetail] + + """ + self.swagger_types = { + 'items': 'list[DisableAutoAssociationDetail]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this DisableAutoAssociationDetails. + A list of information required to disable auto association on a source. + + + :return: The items of this DisableAutoAssociationDetails. + :rtype: list[oci.log_analytics.models.DisableAutoAssociationDetail] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DisableAutoAssociationDetails. + A list of information required to disable auto association on a source. + + + :param items: The items of this DisableAutoAssociationDetails. + :type: list[oci.log_analytics.models.DisableAutoAssociationDetail] + """ + self._items = items + + 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/log_analytics/models/efd_regex_result.py b/src/oci/log_analytics/models/efd_regex_result.py index c32b1edde9..1efe04612b 100644 --- a/src/oci/log_analytics/models/efd_regex_result.py +++ b/src/oci/log_analytics/models/efd_regex_result.py @@ -100,7 +100,7 @@ def __init__(self, **kwargs): def base_field_name(self): """ Gets the base_field_name of this EfdRegexResult. - baseFieldName + The base field name. :return: The base_field_name of this EfdRegexResult. @@ -112,7 +112,7 @@ def base_field_name(self): def base_field_name(self, base_field_name): """ Sets the base_field_name of this EfdRegexResult. - baseFieldName + The base field name. :param base_field_name: The base_field_name of this EfdRegexResult. @@ -124,7 +124,7 @@ def base_field_name(self, base_field_name): def id(self): """ Gets the id of this EfdRegexResult. - id + the unique identifier. :return: The id of this EfdRegexResult. @@ -136,7 +136,7 @@ def id(self): def id(self, id): """ Sets the id of this EfdRegexResult. - id + the unique identifier. :param id: The id of this EfdRegexResult. @@ -168,7 +168,7 @@ def match_result(self, match_result): def parsed_field_count(self): """ Gets the parsed_field_count of this EfdRegexResult. - parsedFieldCount + The parsed field count. :return: The parsed_field_count of this EfdRegexResult. @@ -180,7 +180,7 @@ def parsed_field_count(self): def parsed_field_count(self, parsed_field_count): """ Sets the parsed_field_count of this EfdRegexResult. - parsedFieldCount + The parsed field count. :param parsed_field_count: The parsed_field_count of this EfdRegexResult. @@ -192,7 +192,7 @@ def parsed_field_count(self, parsed_field_count): def parsed_fields(self): """ Gets the parsed_fields of this EfdRegexResult. - parsedFields + The parsed fields. :return: The parsed_fields of this EfdRegexResult. @@ -204,7 +204,7 @@ def parsed_fields(self): def parsed_fields(self, parsed_fields): """ Sets the parsed_fields of this EfdRegexResult. - parsedFields + The parsed fields. :param parsed_fields: The parsed_fields of this EfdRegexResult. @@ -216,7 +216,7 @@ def parsed_fields(self, parsed_fields): def regex(self): """ Gets the regex of this EfdRegexResult. - regex + The regular expression. :return: The regex of this EfdRegexResult. @@ -228,7 +228,7 @@ def regex(self): def regex(self, regex): """ Sets the regex of this EfdRegexResult. - regex + The regular expression. :param regex: The regex of this EfdRegexResult. @@ -240,7 +240,7 @@ def regex(self, regex): def status(self): """ Gets the status of this EfdRegexResult. - status + The status. :return: The status of this EfdRegexResult. @@ -252,7 +252,7 @@ def status(self): def status(self, status): """ Sets the status of this EfdRegexResult. - status + The status. :param status: The status of this EfdRegexResult. @@ -264,7 +264,7 @@ def status(self, status): def status_description(self): """ Gets the status_description of this EfdRegexResult. - statusDescription + The Status description. :return: The status_description of this EfdRegexResult. @@ -276,7 +276,7 @@ def status_description(self): def status_description(self, status_description): """ Sets the status_description of this EfdRegexResult. - statusDescription + The Status description. :param status_description: The status_description of this EfdRegexResult. @@ -288,7 +288,7 @@ def status_description(self, status_description): def is_valid_regex_syntax(self): """ Gets the is_valid_regex_syntax of this EfdRegexResult. - isValidRegexSyntax + A flag indicating whether or not the regular expression is valid. :return: The is_valid_regex_syntax of this EfdRegexResult. @@ -300,7 +300,7 @@ def is_valid_regex_syntax(self): def is_valid_regex_syntax(self, is_valid_regex_syntax): """ Sets the is_valid_regex_syntax of this EfdRegexResult. - isValidRegexSyntax + A flag indicating whether or not the regular expression is valid. :param is_valid_regex_syntax: The is_valid_regex_syntax of this EfdRegexResult. @@ -312,7 +312,7 @@ def is_valid_regex_syntax(self, is_valid_regex_syntax): def violations(self): """ Gets the violations of this EfdRegexResult. - violations + The list of violations (if any). :return: The violations of this EfdRegexResult. @@ -324,7 +324,7 @@ def violations(self): def violations(self, violations): """ Sets the violations of this EfdRegexResult. - violations + The list of violations (if any). :param violations: The violations of this EfdRegexResult. diff --git a/src/oci/log_analytics/models/enable_auto_association_detail.py b/src/oci/log_analytics/models/enable_auto_association_detail.py new file mode 100644 index 0000000000..adc44abd68 --- /dev/null +++ b/src/oci/log_analytics/models/enable_auto_association_detail.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EnableAutoAssociationDetail(object): + """ + The information required to enable log source auto-association. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EnableAutoAssociationDetail object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param log_group_id: + The value to assign to the log_group_id property of this EnableAutoAssociationDetail. + :type log_group_id: str + + """ + self.swagger_types = { + 'log_group_id': 'str' + } + + self.attribute_map = { + 'log_group_id': 'logGroupId' + } + + self._log_group_id = None + + @property + def log_group_id(self): + """ + Gets the log_group_id of this EnableAutoAssociationDetail. + The unique identifier of the log group to use when auto-associting the log source to + eligible entities. + + + :return: The log_group_id of this EnableAutoAssociationDetail. + :rtype: str + """ + return self._log_group_id + + @log_group_id.setter + def log_group_id(self, log_group_id): + """ + Sets the log_group_id of this EnableAutoAssociationDetail. + The unique identifier of the log group to use when auto-associting the log source to + eligible entities. + + + :param log_group_id: The log_group_id of this EnableAutoAssociationDetail. + :type: str + """ + self._log_group_id = log_group_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/log_analytics/models/enable_auto_association_details.py b/src/oci/log_analytics/models/enable_auto_association_details.py new file mode 100644 index 0000000000..975f7eac9c --- /dev/null +++ b/src/oci/log_analytics/models/enable_auto_association_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EnableAutoAssociationDetails(object): + """ + The information required to enable log source auto-association. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EnableAutoAssociationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this EnableAutoAssociationDetails. + :type items: list[oci.log_analytics.models.EnableAutoAssociationDetail] + + """ + self.swagger_types = { + 'items': 'list[EnableAutoAssociationDetail]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this EnableAutoAssociationDetails. + A list of information required to enable auto association on a source. + + + :return: The items of this EnableAutoAssociationDetails. + :rtype: list[oci.log_analytics.models.EnableAutoAssociationDetail] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this EnableAutoAssociationDetails. + A list of information required to enable auto association on a source. + + + :param items: The items of this EnableAutoAssociationDetails. + :type: list[oci.log_analytics.models.EnableAutoAssociationDetail] + """ + self._items = items + + 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/log_analytics/models/event_type.py b/src/oci/log_analytics/models/event_type.py index 66d04a3280..8880ae5857 100644 --- a/src/oci/log_analytics/models/event_type.py +++ b/src/oci/log_analytics/models/event_type.py @@ -34,25 +34,32 @@ def __init__(self, **kwargs): The value to assign to the is_system property of this EventType. :type is_system: bool + :param time_updated: + The value to assign to the time_updated property of this EventType. + :type time_updated: datetime + """ self.swagger_types = { 'event_type_name': 'str', 'spec_version': 'str', 'is_enabled': 'bool', - 'is_system': 'bool' + 'is_system': 'bool', + 'time_updated': 'datetime' } self.attribute_map = { 'event_type_name': 'eventTypeName', 'spec_version': 'specVersion', 'is_enabled': 'isEnabled', - 'is_system': 'isSystem' + 'is_system': 'isSystem', + 'time_updated': 'timeUpdated' } self._event_type_name = None self._spec_version = None self._is_enabled = None self._is_system = None + self._time_updated = None @property def event_type_name(self): @@ -150,6 +157,30 @@ def is_system(self, is_system): """ self._is_system = is_system + @property + def time_updated(self): + """ + Gets the time_updated of this EventType. + The last updated time. + + + :return: The time_updated of this EventType. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this EventType. + The last updated time. + + + :param time_updated: The time_updated of this EventType. + :type: datetime + """ + self._time_updated = time_updated + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/event_type_collection.py b/src/oci/log_analytics/models/event_type_collection.py new file mode 100644 index 0000000000..b99511cb14 --- /dev/null +++ b/src/oci/log_analytics/models/event_type_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EventTypeCollection(object): + """ + The collection of event types and corresponding versions mapped to the source. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EventTypeCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this EventTypeCollection. + :type items: list[oci.log_analytics.models.EventType] + + """ + self.swagger_types = { + 'items': 'list[EventType]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this EventTypeCollection. + An array of event type specifications. + + + :return: The items of this EventTypeCollection. + :rtype: list[oci.log_analytics.models.EventType] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this EventTypeCollection. + An array of event type specifications. + + + :param items: The items of this EventTypeCollection. + :type: list[oci.log_analytics.models.EventType] + """ + self._items = items + + 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/log_analytics/models/event_type_details.py b/src/oci/log_analytics/models/event_type_details.py new file mode 100644 index 0000000000..7ea9f3fb33 --- /dev/null +++ b/src/oci/log_analytics/models/event_type_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EventTypeDetails(object): + """ + The collection of event types and corresponding versions mapped to the source. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EventTypeDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this EventTypeDetails. + :type items: list[oci.log_analytics.models.EventType] + + """ + self.swagger_types = { + 'items': 'list[EventType]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + Gets the items of this EventTypeDetails. + An array of event type specifications. + + + :return: The items of this EventTypeDetails. + :rtype: list[oci.log_analytics.models.EventType] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this EventTypeDetails. + An array of event type specifications. + + + :param items: The items of this EventTypeDetails. + :type: list[oci.log_analytics.models.EventType] + """ + self._items = items + + 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/log_analytics/models/export_content.py b/src/oci/log_analytics/models/export_content.py index 75047dde6e..441228799f 100644 --- a/src/oci/log_analytics/models/export_content.py +++ b/src/oci/log_analytics/models/export_content.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ExportContent(object): """ - ExportContent + The content to export. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def field_names(self): """ Gets the field_names of this ExportContent. - fieldNames + The field names. :return: The field_names of this ExportContent. @@ -63,7 +63,7 @@ def field_names(self): def field_names(self, field_names): """ Sets the field_names of this ExportContent. - fieldNames + The field names. :param field_names: The field_names of this ExportContent. @@ -75,7 +75,7 @@ def field_names(self, field_names): def parser_names(self): """ Gets the parser_names of this ExportContent. - parserNames + The parser names. :return: The parser_names of this ExportContent. @@ -87,7 +87,7 @@ def parser_names(self): def parser_names(self, parser_names): """ Sets the parser_names of this ExportContent. - parserNames + The parser names. :param parser_names: The parser_names of this ExportContent. @@ -99,7 +99,7 @@ def parser_names(self, parser_names): def source_names(self): """ Gets the source_names of this ExportContent. - sourceNames + The source names. :return: The source_names of this ExportContent. @@ -111,7 +111,7 @@ def source_names(self): def source_names(self, source_names): """ Sets the source_names of this ExportContent. - sourceNames + The source names. :param source_names: The source_names of this ExportContent. diff --git a/src/oci/log_analytics/models/extended_fields_validation_result.py b/src/oci/log_analytics/models/extended_fields_validation_result.py index e605d99fa5..d806b78ab8 100644 --- a/src/oci/log_analytics/models/extended_fields_validation_result.py +++ b/src/oci/log_analytics/models/extended_fields_validation_result.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this ExtendedFieldsValidationResult. - items + The regular expression evaluation result of an extended field definition. :return: The items of this ExtendedFieldsValidationResult. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this ExtendedFieldsValidationResult. - items + The regular expression evaluation result of an extended field definition. :param items: The items of this ExtendedFieldsValidationResult. diff --git a/src/oci/log_analytics/models/extract_log_field_results.py b/src/oci/log_analytics/models/extract_log_field_results.py index 541e36341e..447305ca07 100644 --- a/src/oci/log_analytics/models/extract_log_field_results.py +++ b/src/oci/log_analytics/models/extract_log_field_results.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def paths(self): """ Gets the paths of this ExtractLogFieldResults. - log field path values + The log field path values. :return: The paths of this ExtractLogFieldResults. @@ -49,7 +49,7 @@ def paths(self): def paths(self, paths): """ Sets the paths of this ExtractLogFieldResults. - log field path values + The log field path values. :param paths: The paths of this ExtractLogFieldResults. diff --git a/src/oci/log_analytics/models/extract_log_header_details.py b/src/oci/log_analytics/models/extract_log_header_details.py index 00bb710acf..bc68904894 100644 --- a/src/oci/log_analytics/models/extract_log_header_details.py +++ b/src/oci/log_analytics/models/extract_log_header_details.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def log_key(self): """ Gets the log_key of this ExtractLogHeaderDetails. - key + The log key. :return: The log_key of this ExtractLogHeaderDetails. @@ -56,7 +56,7 @@ def log_key(self): def log_key(self, log_key): """ Sets the log_key of this ExtractLogHeaderDetails. - key + The log key. :param log_key: The log_key of this ExtractLogHeaderDetails. @@ -68,7 +68,7 @@ def log_key(self, log_key): def header_values(self): """ Gets the header_values of this ExtractLogHeaderDetails. - log header values + The log header values. :return: The header_values of this ExtractLogHeaderDetails. @@ -80,7 +80,7 @@ def header_values(self): def header_values(self, header_values): """ Sets the header_values of this ExtractLogHeaderDetails. - log header values + The log header values. :param header_values: The header_values of this ExtractLogHeaderDetails. diff --git a/src/oci/log_analytics/models/extract_log_header_results.py b/src/oci/log_analytics/models/extract_log_header_results.py index bb5f88a05c..9e6f39f336 100644 --- a/src/oci/log_analytics/models/extract_log_header_results.py +++ b/src/oci/log_analytics/models/extract_log_header_results.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def json_paths(self): """ Gets the json_paths of this ExtractLogHeaderResults. - log header json paths + The log header json paths. :return: The json_paths of this ExtractLogHeaderResults. @@ -56,7 +56,7 @@ def json_paths(self): def json_paths(self, json_paths): """ Sets the json_paths of this ExtractLogHeaderResults. - log header json paths + The log header json paths. :param json_paths: The json_paths of this ExtractLogHeaderResults. @@ -68,7 +68,7 @@ def json_paths(self, json_paths): def xml_paths(self): """ Gets the xml_paths of this ExtractLogHeaderResults. - log field or header values + The log field or log header values. :return: The xml_paths of this ExtractLogHeaderResults. @@ -80,7 +80,7 @@ def xml_paths(self): def xml_paths(self, xml_paths): """ Sets the xml_paths of this ExtractLogHeaderResults. - log field or header values + The log field or log header values. :param xml_paths: The xml_paths of this ExtractLogHeaderResults. diff --git a/src/oci/log_analytics/models/field_summary_report.py b/src/oci/log_analytics/models/field_summary_report.py index 4b3eee91ab..0c45ddcd57 100644 --- a/src/oci/log_analytics/models/field_summary_report.py +++ b/src/oci/log_analytics/models/field_summary_report.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def non_oob_count(self): """ Gets the non_oob_count of this FieldSummaryReport. - non out-of-the-box count + The count of custom (user defined) fields. :return: The non_oob_count of this FieldSummaryReport. @@ -63,7 +63,7 @@ def non_oob_count(self): def non_oob_count(self, non_oob_count): """ Sets the non_oob_count of this FieldSummaryReport. - non out-of-the-box count + The count of custom (user defined) fields. :param non_oob_count: The non_oob_count of this FieldSummaryReport. @@ -75,7 +75,7 @@ def non_oob_count(self, non_oob_count): def oob_count(self): """ Gets the oob_count of this FieldSummaryReport. - out-of-the-box count + The count of built in fields. :return: The oob_count of this FieldSummaryReport. @@ -87,7 +87,7 @@ def oob_count(self): def oob_count(self, oob_count): """ Sets the oob_count of this FieldSummaryReport. - out-of-the-box count + The count of built in fields. :param oob_count: The oob_count of this FieldSummaryReport. @@ -99,7 +99,7 @@ def oob_count(self, oob_count): def usage_details(self): """ Gets the usage_details of this FieldSummaryReport. - usage detail + Field usage detailss :return: The usage_details of this FieldSummaryReport. @@ -111,7 +111,7 @@ def usage_details(self): def usage_details(self, usage_details): """ Sets the usage_details of this FieldSummaryReport. - usage detail + Field usage detailss :param usage_details: The usage_details of this FieldSummaryReport. diff --git a/src/oci/log_analytics/models/indexes.py b/src/oci/log_analytics/models/indexes.py index 48b50bc562..e9aef5bf3f 100644 --- a/src/oci/log_analytics/models/indexes.py +++ b/src/oci/log_analytics/models/indexes.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def end_index(self): """ Gets the end_index of this Indexes. - endIndex + The end index. :return: The end_index of this Indexes. @@ -56,7 +56,7 @@ def end_index(self): def end_index(self, end_index): """ Sets the end_index of this Indexes. - endIndex + The end index. :param end_index: The end_index of this Indexes. @@ -68,7 +68,7 @@ def end_index(self, end_index): def start_index(self): """ Gets the start_index of this Indexes. - startIndex + The start index. :return: The start_index of this Indexes. @@ -80,7 +80,7 @@ def start_index(self): def start_index(self, start_index): """ Sets the start_index of this Indexes. - startIndex + The start index. :param start_index: The start_index of this Indexes. diff --git a/src/oci/log_analytics/models/label_names.py b/src/oci/log_analytics/models/label_names.py index 64b7de944e..24d239f2f7 100644 --- a/src/oci/log_analytics/models/label_names.py +++ b/src/oci/log_analytics/models/label_names.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def label_names(self): """ Gets the label_names of this LabelNames. - string list + An array of label names. :return: The label_names of this LabelNames. @@ -49,7 +49,7 @@ def label_names(self): def label_names(self, label_names): """ Sets the label_names of this LabelNames. - string list + An array of label names. :param label_names: The label_names of this LabelNames. diff --git a/src/oci/log_analytics/models/label_priority.py b/src/oci/log_analytics/models/label_priority.py index e47563c927..8c779c64ef 100644 --- a/src/oci/log_analytics/models/label_priority.py +++ b/src/oci/log_analytics/models/label_priority.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LabelPriority(object): """ - Label Priority + The label priority. """ #: A constant which can be used with the priority property of a LabelPriority. @@ -55,7 +55,7 @@ def __init__(self, **kwargs): def priority(self): """ Gets the priority of this LabelPriority. - tag priority + The label priority. Default value is NONE. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -70,7 +70,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this LabelPriority. - tag priority + The label priority. Default value is NONE. :param priority: The priority of this LabelPriority. diff --git a/src/oci/log_analytics/models/label_priority_collection.py b/src/oci/log_analytics/models/label_priority_collection.py index 5d6f8143f9..c8814b3b46 100644 --- a/src/oci/log_analytics/models/label_priority_collection.py +++ b/src/oci/log_analytics/models/label_priority_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LabelPriorityCollection. - list of tag priorities + An array of label priorities. :return: The items of this LabelPriorityCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LabelPriorityCollection. - list of tag priorities + An array of label priorities. :param items: The items of this LabelPriorityCollection. diff --git a/src/oci/log_analytics/models/label_source_collection.py b/src/oci/log_analytics/models/label_source_collection.py index c35974da04..2989b2511d 100644 --- a/src/oci/log_analytics/models/label_source_collection.py +++ b/src/oci/log_analytics/models/label_source_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LabelSourceCollection. - list of fields + An array labels. :return: The items of this LabelSourceCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LabelSourceCollection. - list of fields + An array labels. :param items: The items of this LabelSourceCollection. diff --git a/src/oci/log_analytics/models/label_source_summary.py b/src/oci/log_analytics/models/label_source_summary.py index 0782a33cc9..09315c1681 100644 --- a/src/oci/log_analytics/models/label_source_summary.py +++ b/src/oci/log_analytics/models/label_source_summary.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def source_display_name(self): """ Gets the source_display_name of this LabelSourceSummary. - display name + The source display name. :return: The source_display_name of this LabelSourceSummary. @@ -91,7 +91,7 @@ def source_display_name(self): def source_display_name(self, source_display_name): """ Sets the source_display_name of this LabelSourceSummary. - display name + The source display name. :param source_display_name: The source_display_name of this LabelSourceSummary. @@ -103,7 +103,7 @@ def source_display_name(self, source_display_name): def source_name(self): """ Gets the source_name of this LabelSourceSummary. - source internal name + The source internal name. :return: The source_name of this LabelSourceSummary. @@ -115,7 +115,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this LabelSourceSummary. - source internal name + The source internal name. :param source_name: The source_name of this LabelSourceSummary. @@ -127,7 +127,7 @@ def source_name(self, source_name): def source_id(self): """ Gets the source_id of this LabelSourceSummary. - source Id + The source unique identifier. :return: The source_id of this LabelSourceSummary. @@ -139,7 +139,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LabelSourceSummary. - source Id + The source unique identifier. :param source_id: The source_id of this LabelSourceSummary. @@ -151,7 +151,7 @@ def source_id(self, source_id): def label_operator_name(self): """ Gets the label_operator_name of this LabelSourceSummary. - label Operator + The label operator. :return: The label_operator_name of this LabelSourceSummary. @@ -163,7 +163,7 @@ def label_operator_name(self): def label_operator_name(self, label_operator_name): """ Sets the label_operator_name of this LabelSourceSummary. - label Operator + The label operator. :param label_operator_name: The label_operator_name of this LabelSourceSummary. @@ -175,7 +175,7 @@ def label_operator_name(self, label_operator_name): def label_condition(self): """ Gets the label_condition of this LabelSourceSummary. - label Condition + The label condition. :return: The label_condition of this LabelSourceSummary. @@ -187,7 +187,7 @@ def label_condition(self): def label_condition(self, label_condition): """ Sets the label_condition of this LabelSourceSummary. - label Condition + The label condition. :param label_condition: The label_condition of this LabelSourceSummary. @@ -199,7 +199,7 @@ def label_condition(self, label_condition): def label_field_displayname(self): """ Gets the label_field_displayname of this LabelSourceSummary. - label Field Display Name + The label field display name. :return: The label_field_displayname of this LabelSourceSummary. @@ -211,7 +211,7 @@ def label_field_displayname(self): def label_field_displayname(self, label_field_displayname): """ Sets the label_field_displayname of this LabelSourceSummary. - label Field Display Name + The label field display name. :param label_field_displayname: The label_field_displayname of this LabelSourceSummary. @@ -223,7 +223,7 @@ def label_field_displayname(self, label_field_displayname): def label_field_name(self): """ Gets the label_field_name of this LabelSourceSummary. - label Field name + The label field name. :return: The label_field_name of this LabelSourceSummary. @@ -235,7 +235,7 @@ def label_field_name(self): def label_field_name(self, label_field_name): """ Sets the label_field_name of this LabelSourceSummary. - label Field name + The label field name. :param label_field_name: The label_field_name of this LabelSourceSummary. diff --git a/src/oci/log_analytics/models/label_summary_report.py b/src/oci/log_analytics/models/label_summary_report.py index 466dc691b0..7109fbb346 100644 --- a/src/oci/log_analytics/models/label_summary_report.py +++ b/src/oci/log_analytics/models/label_summary_report.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def non_oob_count(self): """ Gets the non_oob_count of this LabelSummaryReport. - non out-of-the-box count + The count of custom (user defined) labels. :return: The non_oob_count of this LabelSummaryReport. @@ -56,7 +56,7 @@ def non_oob_count(self): def non_oob_count(self, non_oob_count): """ Sets the non_oob_count of this LabelSummaryReport. - non out-of-the-box count + The count of custom (user defined) labels. :param non_oob_count: The non_oob_count of this LabelSummaryReport. @@ -68,7 +68,7 @@ def non_oob_count(self, non_oob_count): def oob_count(self): """ Gets the oob_count of this LabelSummaryReport. - out-of-the-box count + The count of built in labels. :return: The oob_count of this LabelSummaryReport. @@ -80,7 +80,7 @@ def oob_count(self): def oob_count(self, oob_count): """ Sets the oob_count of this LabelSummaryReport. - out-of-the-box count + The count of built in labels. :param oob_count: The oob_count of this LabelSummaryReport. diff --git a/src/oci/log_analytics/models/log_analytics_associated_entity.py b/src/oci/log_analytics/models/log_analytics_associated_entity.py index 78d17f61aa..d1e613181f 100644 --- a/src/oci/log_analytics/models/log_analytics_associated_entity.py +++ b/src/oci/log_analytics/models/log_analytics_associated_entity.py @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def entity_id(self): """ Gets the entity_id of this LogAnalyticsAssociatedEntity. - entity guid + The entity unique identifier. :return: The entity_id of this LogAnalyticsAssociatedEntity. @@ -84,7 +84,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this LogAnalyticsAssociatedEntity. - entity guid + The entity unique identifier. :param entity_id: The entity_id of this LogAnalyticsAssociatedEntity. @@ -96,7 +96,7 @@ def entity_id(self, entity_id): def entity_name(self): """ Gets the entity_name of this LogAnalyticsAssociatedEntity. - entity name + The entity name. :return: The entity_name of this LogAnalyticsAssociatedEntity. @@ -108,7 +108,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this LogAnalyticsAssociatedEntity. - entity name + The entity name. :param entity_name: The entity_name of this LogAnalyticsAssociatedEntity. @@ -120,7 +120,7 @@ def entity_name(self, entity_name): def entity_type(self): """ Gets the entity_type of this LogAnalyticsAssociatedEntity. - entity type + The entity type. :return: The entity_type of this LogAnalyticsAssociatedEntity. @@ -132,7 +132,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsAssociatedEntity. - entity type + The entity type. :param entity_type: The entity_type of this LogAnalyticsAssociatedEntity. @@ -144,7 +144,7 @@ def entity_type(self, entity_type): def entity_type_display_name(self): """ Gets the entity_type_display_name of this LogAnalyticsAssociatedEntity. - entity type display name + The entity type display name. :return: The entity_type_display_name of this LogAnalyticsAssociatedEntity. @@ -156,7 +156,7 @@ def entity_type_display_name(self): def entity_type_display_name(self, entity_type_display_name): """ Sets the entity_type_display_name of this LogAnalyticsAssociatedEntity. - entity type display name + The entity type display name. :param entity_type_display_name: The entity_type_display_name of this LogAnalyticsAssociatedEntity. @@ -168,7 +168,7 @@ def entity_type_display_name(self, entity_type_display_name): def on_host(self): """ Gets the on_host of this LogAnalyticsAssociatedEntity. - on host + The host associated with the entity. :return: The on_host of this LogAnalyticsAssociatedEntity. @@ -180,7 +180,7 @@ def on_host(self): def on_host(self, on_host): """ Sets the on_host of this LogAnalyticsAssociatedEntity. - on host + The host associated with the entity. :param on_host: The on_host of this LogAnalyticsAssociatedEntity. @@ -192,7 +192,7 @@ def on_host(self, on_host): def association_count(self): """ Gets the association_count of this LogAnalyticsAssociatedEntity. - associationCount + The association count for the entity. :return: The association_count of this LogAnalyticsAssociatedEntity. @@ -204,7 +204,7 @@ def association_count(self): def association_count(self, association_count): """ Sets the association_count of this LogAnalyticsAssociatedEntity. - associationCount + The association count for the entity. :param association_count: The association_count of this LogAnalyticsAssociatedEntity. diff --git a/src/oci/log_analytics/models/log_analytics_associated_entity_collection.py b/src/oci/log_analytics/models/log_analytics_associated_entity_collection.py index da12139610..c43135986c 100644 --- a/src/oci/log_analytics/models/log_analytics_associated_entity_collection.py +++ b/src/oci/log_analytics/models/log_analytics_associated_entity_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsAssociatedEntityCollection. - list of entities + A list of entities. :return: The items of this LogAnalyticsAssociatedEntityCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsAssociatedEntityCollection. - list of entities + A list of entities. :param items: The items of this LogAnalyticsAssociatedEntityCollection. diff --git a/src/oci/log_analytics/models/log_analytics_association.py b/src/oci/log_analytics/models/log_analytics_association.py index cabb2ae2c6..bce184e301 100644 --- a/src/oci/log_analytics/models/log_analytics_association.py +++ b/src/oci/log_analytics/models/log_analytics_association.py @@ -167,7 +167,7 @@ def __init__(self, **kwargs): def failure_message(self): """ Gets the failure_message of this LogAnalyticsAssociation. - failure message + The failure message. :return: The failure_message of this LogAnalyticsAssociation. @@ -179,7 +179,7 @@ def failure_message(self): def failure_message(self, failure_message): """ Sets the failure_message of this LogAnalyticsAssociation. - failure message + The failure message. :param failure_message: The failure_message of this LogAnalyticsAssociation. @@ -191,7 +191,7 @@ def failure_message(self, failure_message): def agent_id(self): """ Gets the agent_id of this LogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :return: The agent_id of this LogAnalyticsAssociation. @@ -203,7 +203,7 @@ def agent_id(self): def agent_id(self, agent_id): """ Sets the agent_id of this LogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :param agent_id: The agent_id of this LogAnalyticsAssociation. @@ -215,7 +215,7 @@ def agent_id(self, agent_id): def time_last_attempted(self): """ Gets the time_last_attempted of this LogAnalyticsAssociation. - last attempt date + The last attempt date. :return: The time_last_attempted of this LogAnalyticsAssociation. @@ -227,7 +227,7 @@ def time_last_attempted(self): def time_last_attempted(self, time_last_attempted): """ Sets the time_last_attempted of this LogAnalyticsAssociation. - last attempt date + The last attempt date. :param time_last_attempted: The time_last_attempted of this LogAnalyticsAssociation. @@ -239,7 +239,8 @@ def time_last_attempted(self, time_last_attempted): def retry_count(self): """ Gets the retry_count of this LogAnalyticsAssociation. - retry count + The number of times the association will be attempted + before failing. :return: The retry_count of this LogAnalyticsAssociation. @@ -251,7 +252,8 @@ def retry_count(self): def retry_count(self, retry_count): """ Sets the retry_count of this LogAnalyticsAssociation. - retry count + The number of times the association will be attempted + before failing. :param retry_count: The retry_count of this LogAnalyticsAssociation. @@ -263,7 +265,7 @@ def retry_count(self, retry_count): def source_name(self): """ Gets the source_name of this LogAnalyticsAssociation. - source name + The source name. :return: The source_name of this LogAnalyticsAssociation. @@ -275,7 +277,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this LogAnalyticsAssociation. - source name + The source name. :param source_name: The source_name of this LogAnalyticsAssociation. @@ -287,7 +289,7 @@ def source_name(self, source_name): def source_display_name(self): """ Gets the source_display_name of this LogAnalyticsAssociation. - source display name + The source display name. :return: The source_display_name of this LogAnalyticsAssociation. @@ -299,7 +301,7 @@ def source_display_name(self): def source_display_name(self, source_display_name): """ Sets the source_display_name of this LogAnalyticsAssociation. - source display name + The source display name. :param source_display_name: The source_display_name of this LogAnalyticsAssociation. @@ -311,7 +313,7 @@ def source_display_name(self, source_display_name): def source_type_name(self): """ Gets the source_type_name of this LogAnalyticsAssociation. - source type internal name + The source type internal name. :return: The source_type_name of this LogAnalyticsAssociation. @@ -323,7 +325,7 @@ def source_type_name(self): def source_type_name(self, source_type_name): """ Sets the source_type_name of this LogAnalyticsAssociation. - source type internal name + The source type internal name. :param source_type_name: The source_type_name of this LogAnalyticsAssociation. @@ -335,7 +337,8 @@ def source_type_name(self, source_type_name): def life_cycle_state(self): """ Gets the life_cycle_state of this LogAnalyticsAssociation. - lifeCycleState + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED. Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -350,7 +353,8 @@ def life_cycle_state(self): def life_cycle_state(self, life_cycle_state): """ Sets the life_cycle_state of this LogAnalyticsAssociation. - lifeCycleState + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED. :param life_cycle_state: The life_cycle_state of this LogAnalyticsAssociation. @@ -365,7 +369,7 @@ def life_cycle_state(self, life_cycle_state): def entity_id(self): """ Gets the entity_id of this LogAnalyticsAssociation. - entity GUID + The entity unique identifier. :return: The entity_id of this LogAnalyticsAssociation. @@ -377,7 +381,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this LogAnalyticsAssociation. - entity GUID + The entity unique identifier. :param entity_id: The entity_id of this LogAnalyticsAssociation. @@ -389,7 +393,7 @@ def entity_id(self, entity_id): def entity_name(self): """ Gets the entity_name of this LogAnalyticsAssociation. - entity name + The entity name. :return: The entity_name of this LogAnalyticsAssociation. @@ -401,7 +405,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this LogAnalyticsAssociation. - entity name + The entity name. :param entity_name: The entity_name of this LogAnalyticsAssociation. @@ -413,7 +417,7 @@ def entity_name(self, entity_name): def entity_type_name(self): """ Gets the entity_type_name of this LogAnalyticsAssociation. - entity type internal name + The entity type internal name. :return: The entity_type_name of this LogAnalyticsAssociation. @@ -425,7 +429,7 @@ def entity_type_name(self): def entity_type_name(self, entity_type_name): """ Sets the entity_type_name of this LogAnalyticsAssociation. - entity type internal name + The entity type internal name. :param entity_type_name: The entity_type_name of this LogAnalyticsAssociation. @@ -437,7 +441,7 @@ def entity_type_name(self, entity_type_name): def host(self): """ Gets the host of this LogAnalyticsAssociation. - host name + The host name. :return: The host of this LogAnalyticsAssociation. @@ -449,7 +453,7 @@ def host(self): def host(self, host): """ Sets the host of this LogAnalyticsAssociation. - host name + The host name. :param host: The host of this LogAnalyticsAssociation. @@ -461,7 +465,7 @@ def host(self, host): def agent_entity_name(self): """ Gets the agent_entity_name of this LogAnalyticsAssociation. - Agent entity name + The name of the entity which contains the agent. :return: The agent_entity_name of this LogAnalyticsAssociation. @@ -473,7 +477,7 @@ def agent_entity_name(self): def agent_entity_name(self, agent_entity_name): """ Sets the agent_entity_name of this LogAnalyticsAssociation. - Agent entity name + The name of the entity which contains the agent. :param agent_entity_name: The agent_entity_name of this LogAnalyticsAssociation. @@ -485,7 +489,7 @@ def agent_entity_name(self, agent_entity_name): def entity_type_display_name(self): """ Gets the entity_type_display_name of this LogAnalyticsAssociation. - entity type display name + The entity type display name. :return: The entity_type_display_name of this LogAnalyticsAssociation. @@ -497,7 +501,7 @@ def entity_type_display_name(self): def entity_type_display_name(self, entity_type_display_name): """ Sets the entity_type_display_name of this LogAnalyticsAssociation. - entity type display name + The entity type display name. :param entity_type_display_name: The entity_type_display_name of this LogAnalyticsAssociation. @@ -509,7 +513,7 @@ def entity_type_display_name(self, entity_type_display_name): def log_group_id(self): """ Gets the log_group_id of this LogAnalyticsAssociation. - log group ocid + The log group unique identifier. :return: The log_group_id of this LogAnalyticsAssociation. @@ -521,7 +525,7 @@ def log_group_id(self): def log_group_id(self, log_group_id): """ Sets the log_group_id of this LogAnalyticsAssociation. - log group ocid + The log group unique identifier. :param log_group_id: The log_group_id of this LogAnalyticsAssociation. @@ -533,7 +537,7 @@ def log_group_id(self, log_group_id): def log_group_name(self): """ Gets the log_group_name of this LogAnalyticsAssociation. - log group name + The log group name. :return: The log_group_name of this LogAnalyticsAssociation. @@ -545,7 +549,7 @@ def log_group_name(self): def log_group_name(self, log_group_name): """ Sets the log_group_name of this LogAnalyticsAssociation. - log group name + The log group name. :param log_group_name: The log_group_name of this LogAnalyticsAssociation. @@ -557,7 +561,7 @@ def log_group_name(self, log_group_name): def log_group_compartment(self): """ Gets the log_group_compartment of this LogAnalyticsAssociation. - log group compartment + The log group compartment. :return: The log_group_compartment of this LogAnalyticsAssociation. @@ -569,7 +573,7 @@ def log_group_compartment(self): def log_group_compartment(self, log_group_compartment): """ Sets the log_group_compartment of this LogAnalyticsAssociation. - log group compartment + The log group compartment. :param log_group_compartment: The log_group_compartment of this LogAnalyticsAssociation. diff --git a/src/oci/log_analytics/models/log_analytics_association_collection.py b/src/oci/log_analytics/models/log_analytics_association_collection.py index 4af189e6ee..88476ef803 100644 --- a/src/oci/log_analytics/models/log_analytics_association_collection.py +++ b/src/oci/log_analytics/models/log_analytics_association_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogAnalyticsAssociationCollection(object): """ - LogAnalyticsAssociationCollection + A collection of associations. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsAssociationCollection. - list of rule entity association details + An array of associations. :return: The items of this LogAnalyticsAssociationCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsAssociationCollection. - list of rule entity association details + An array of associations. :param items: The items of this LogAnalyticsAssociationCollection. diff --git a/src/oci/log_analytics/models/log_analytics_association_parameter.py b/src/oci/log_analytics/models/log_analytics_association_parameter.py index 52209049ad..b990a1bcfb 100644 --- a/src/oci/log_analytics/models/log_analytics_association_parameter.py +++ b/src/oci/log_analytics/models/log_analytics_association_parameter.py @@ -103,7 +103,7 @@ def __init__(self, **kwargs): def agent_id(self): """ Gets the agent_id of this LogAnalyticsAssociationParameter. - agent guid + The agent unique identifier. :return: The agent_id of this LogAnalyticsAssociationParameter. @@ -115,7 +115,7 @@ def agent_id(self): def agent_id(self, agent_id): """ Sets the agent_id of this LogAnalyticsAssociationParameter. - agent guid + The agent unique identifier. :param agent_id: The agent_id of this LogAnalyticsAssociationParameter. @@ -127,7 +127,7 @@ def agent_id(self, agent_id): def entity_type(self): """ Gets the entity_type of this LogAnalyticsAssociationParameter. - entity type + The entity type. :return: The entity_type of this LogAnalyticsAssociationParameter. @@ -139,7 +139,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsAssociationParameter. - entity type + The entity type. :param entity_type: The entity_type of this LogAnalyticsAssociationParameter. @@ -151,7 +151,7 @@ def entity_type(self, entity_type): def entity_id(self): """ Gets the entity_id of this LogAnalyticsAssociationParameter. - entity guid + The entity unique identifier. :return: The entity_id of this LogAnalyticsAssociationParameter. @@ -163,7 +163,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this LogAnalyticsAssociationParameter. - entity guid + The entity unique identifier. :param entity_id: The entity_id of this LogAnalyticsAssociationParameter. @@ -175,7 +175,7 @@ def entity_id(self, entity_id): def source_id(self): """ Gets the source_id of this LogAnalyticsAssociationParameter. - source name + The source name. :return: The source_id of this LogAnalyticsAssociationParameter. @@ -187,7 +187,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsAssociationParameter. - source name + The source name. :param source_id: The source_id of this LogAnalyticsAssociationParameter. @@ -199,7 +199,7 @@ def source_id(self, source_id): def source_display_name(self): """ Gets the source_display_name of this LogAnalyticsAssociationParameter. - source display name + The source display name. :return: The source_display_name of this LogAnalyticsAssociationParameter. @@ -211,7 +211,7 @@ def source_display_name(self): def source_display_name(self, source_display_name): """ Sets the source_display_name of this LogAnalyticsAssociationParameter. - source display name + The source display name. :param source_display_name: The source_display_name of this LogAnalyticsAssociationParameter. @@ -223,7 +223,7 @@ def source_display_name(self, source_display_name): def source_type(self): """ Gets the source_type of this LogAnalyticsAssociationParameter. - source type + The source type. :return: The source_type of this LogAnalyticsAssociationParameter. @@ -235,7 +235,7 @@ def source_type(self): def source_type(self, source_type): """ Sets the source_type of this LogAnalyticsAssociationParameter. - source type + The source type. :param source_type: The source_type of this LogAnalyticsAssociationParameter. @@ -247,7 +247,7 @@ def source_type(self, source_type): def status(self): """ Gets the status of this LogAnalyticsAssociationParameter. - status + The status. Either FAILED or SUCCEEDED. Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -262,7 +262,7 @@ def status(self): def status(self, status): """ Sets the status of this LogAnalyticsAssociationParameter. - status + The status. Either FAILED or SUCCEEDED. :param status: The status of this LogAnalyticsAssociationParameter. @@ -277,7 +277,7 @@ def status(self, status): def missing_properties(self): """ Gets the missing_properties of this LogAnalyticsAssociationParameter. - missingProperties + A list of missing properties. :return: The missing_properties of this LogAnalyticsAssociationParameter. @@ -289,7 +289,7 @@ def missing_properties(self): def missing_properties(self, missing_properties): """ Sets the missing_properties of this LogAnalyticsAssociationParameter. - missingProperties + A list of missing properties. :param missing_properties: The missing_properties of this LogAnalyticsAssociationParameter. @@ -301,7 +301,7 @@ def missing_properties(self, missing_properties): def required_properties(self): """ Gets the required_properties of this LogAnalyticsAssociationParameter. - requiredProperties + A list of requried properties. :return: The required_properties of this LogAnalyticsAssociationParameter. @@ -313,7 +313,7 @@ def required_properties(self): def required_properties(self, required_properties): """ Sets the required_properties of this LogAnalyticsAssociationParameter. - requiredProperties + A list of requried properties. :param required_properties: The required_properties of this LogAnalyticsAssociationParameter. diff --git a/src/oci/log_analytics/models/log_analytics_association_parameter_collection.py b/src/oci/log_analytics/models/log_analytics_association_parameter_collection.py index 159d28ae4e..2ba1550c09 100644 --- a/src/oci/log_analytics/models/log_analytics_association_parameter_collection.py +++ b/src/oci/log_analytics/models/log_analytics_association_parameter_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsAssociationParameterCollection. - list of entities + A list of association parameters. :return: The items of this LogAnalyticsAssociationParameterCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsAssociationParameterCollection. - list of entities + A list of association parameters. :param items: The items of this LogAnalyticsAssociationParameterCollection. diff --git a/src/oci/log_analytics/models/log_analytics_config_work_request.py b/src/oci/log_analytics/models/log_analytics_config_work_request.py index 99c6b390a5..4021563d45 100644 --- a/src/oci/log_analytics/models/log_analytics_config_work_request.py +++ b/src/oci/log_analytics/models/log_analytics_config_work_request.py @@ -133,7 +133,7 @@ def __init__(self, **kwargs): def id(self): """ Gets the id of this LogAnalyticsConfigWorkRequest. - workrequest id + The workrequest unique identifier. :return: The id of this LogAnalyticsConfigWorkRequest. @@ -145,7 +145,7 @@ def id(self): def id(self, id): """ Sets the id of this LogAnalyticsConfigWorkRequest. - workrequest id + The workrequest unique identifier. :param id: The id of this LogAnalyticsConfigWorkRequest. @@ -157,7 +157,7 @@ def id(self, id): def compartment_id(self): """ Gets the compartment_id of this LogAnalyticsConfigWorkRequest. - compartment id + The compartment unique identifier. :return: The compartment_id of this LogAnalyticsConfigWorkRequest. @@ -169,7 +169,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this LogAnalyticsConfigWorkRequest. - compartment id + The compartment unique identifier. :param compartment_id: The compartment_id of this LogAnalyticsConfigWorkRequest. @@ -181,7 +181,9 @@ def compartment_id(self, compartment_id): def operation_type(self): """ Gets the operation_type of this LogAnalyticsConfigWorkRequest. - operation type + The operation type. There are two classes of operations, association operations and + lookup operations. Associations may be created or deleted, and lookup operations include + append, update and delete. Allowed values for this property are: "CREATE_ASSOCIATIONS", "DELETE_ASSOCIATIONS", "APPEND_LOOKUP_DATA", "UPDATE_LOOKUP_DATA", "DELETE_LOOKUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -196,7 +198,9 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this LogAnalyticsConfigWorkRequest. - operation type + The operation type. There are two classes of operations, association operations and + lookup operations. Associations may be created or deleted, and lookup operations include + append, update and delete. :param operation_type: The operation_type of this LogAnalyticsConfigWorkRequest. @@ -211,7 +215,7 @@ def operation_type(self, operation_type): def payload(self): """ Gets the payload of this LogAnalyticsConfigWorkRequest. - list of log group summary objects + The list of config work request responses. :return: The payload of this LogAnalyticsConfigWorkRequest. @@ -223,7 +227,7 @@ def payload(self): def payload(self, payload): """ Sets the payload of this LogAnalyticsConfigWorkRequest. - list of log group summary objects + The list of config work request responses. :param payload: The payload of this LogAnalyticsConfigWorkRequest. @@ -235,7 +239,7 @@ def payload(self, payload): def percent_complete(self): """ Gets the percent_complete of this LogAnalyticsConfigWorkRequest. - percentage complete + The completion percentage. :return: The percent_complete of this LogAnalyticsConfigWorkRequest. @@ -247,7 +251,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this LogAnalyticsConfigWorkRequest. - percentage complete + The completion percentage. :param percent_complete: The percent_complete of this LogAnalyticsConfigWorkRequest. @@ -259,7 +263,7 @@ def percent_complete(self, percent_complete): def time_started(self): """ Gets the time_started of this LogAnalyticsConfigWorkRequest. - when the work request was started + The time at which the work request was started. :return: The time_started of this LogAnalyticsConfigWorkRequest. @@ -271,7 +275,7 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this LogAnalyticsConfigWorkRequest. - when the work request was started + The time at which the work request was started. :param time_started: The time_started of this LogAnalyticsConfigWorkRequest. @@ -283,7 +287,7 @@ def time_started(self, time_started): def time_accepted(self): """ Gets the time_accepted of this LogAnalyticsConfigWorkRequest. - when the work request was accepted + The time at which the work request was accepted. :return: The time_accepted of this LogAnalyticsConfigWorkRequest. @@ -295,7 +299,7 @@ def time_accepted(self): def time_accepted(self, time_accepted): """ Sets the time_accepted of this LogAnalyticsConfigWorkRequest. - when the work request was accepted + The time at which the work request was accepted. :param time_accepted: The time_accepted of this LogAnalyticsConfigWorkRequest. @@ -307,7 +311,7 @@ def time_accepted(self, time_accepted): def time_finished(self): """ Gets the time_finished of this LogAnalyticsConfigWorkRequest. - when the work request finished + The time at which the work request was finished. :return: The time_finished of this LogAnalyticsConfigWorkRequest. @@ -319,7 +323,7 @@ def time_finished(self): def time_finished(self, time_finished): """ Sets the time_finished of this LogAnalyticsConfigWorkRequest. - when the work request finished + The time at which the work request was finished. :param time_finished: The time_finished of this LogAnalyticsConfigWorkRequest. @@ -331,7 +335,8 @@ def time_finished(self, time_finished): def lifecycle_state(self): """ Gets the lifecycle_state of this LogAnalyticsConfigWorkRequest. - status + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -346,7 +351,8 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this LogAnalyticsConfigWorkRequest. - status + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED :param lifecycle_state: The lifecycle_state of this LogAnalyticsConfigWorkRequest. diff --git a/src/oci/log_analytics/models/log_analytics_config_work_request_collection.py b/src/oci/log_analytics/models/log_analytics_config_work_request_collection.py index 93fc6c26fe..bb030f6240 100644 --- a/src/oci/log_analytics/models/log_analytics_config_work_request_collection.py +++ b/src/oci/log_analytics/models/log_analytics_config_work_request_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsConfigWorkRequestCollection. - list of workrequest responses + A list of workrequest responses. :return: The items of this LogAnalyticsConfigWorkRequestCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsConfigWorkRequestCollection. - list of workrequest responses + A list of workrequest responses. :param items: The items of this LogAnalyticsConfigWorkRequestCollection. diff --git a/src/oci/log_analytics/models/log_analytics_config_work_request_payload.py b/src/oci/log_analytics/models/log_analytics_config_work_request_payload.py index f1453caebc..8ec0dbac5e 100644 --- a/src/oci/log_analytics/models/log_analytics_config_work_request_payload.py +++ b/src/oci/log_analytics/models/log_analytics_config_work_request_payload.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def source_name(self): """ Gets the source_name of this LogAnalyticsConfigWorkRequestPayload. - sourceName + The source name. :return: The source_name of this LogAnalyticsConfigWorkRequestPayload. @@ -70,7 +70,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this LogAnalyticsConfigWorkRequestPayload. - sourceName + The source name. :param source_name: The source_name of this LogAnalyticsConfigWorkRequestPayload. @@ -82,7 +82,7 @@ def source_name(self, source_name): def entity_id(self): """ Gets the entity_id of this LogAnalyticsConfigWorkRequestPayload. - entityId + The entity unique identifier. :return: The entity_id of this LogAnalyticsConfigWorkRequestPayload. @@ -94,7 +94,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this LogAnalyticsConfigWorkRequestPayload. - entityId + The entity unique identifier. :param entity_id: The entity_id of this LogAnalyticsConfigWorkRequestPayload. @@ -106,7 +106,7 @@ def entity_id(self, entity_id): def lookup_reference(self): """ Gets the lookup_reference of this LogAnalyticsConfigWorkRequestPayload. - lookupReference + The lookup reference as an integer. :return: The lookup_reference of this LogAnalyticsConfigWorkRequestPayload. @@ -118,7 +118,7 @@ def lookup_reference(self): def lookup_reference(self, lookup_reference): """ Sets the lookup_reference of this LogAnalyticsConfigWorkRequestPayload. - lookupReference + The lookup reference as an integer. :param lookup_reference: The lookup_reference of this LogAnalyticsConfigWorkRequestPayload. diff --git a/src/oci/log_analytics/models/log_analytics_config_work_request_summary.py b/src/oci/log_analytics/models/log_analytics_config_work_request_summary.py index 30fde630e5..10fbea5f08 100644 --- a/src/oci/log_analytics/models/log_analytics_config_work_request_summary.py +++ b/src/oci/log_analytics/models/log_analytics_config_work_request_summary.py @@ -119,7 +119,7 @@ def __init__(self, **kwargs): def id(self): """ Gets the id of this LogAnalyticsConfigWorkRequestSummary. - workrequest id + The workrequest unique identifier. :return: The id of this LogAnalyticsConfigWorkRequestSummary. @@ -131,7 +131,7 @@ def id(self): def id(self, id): """ Sets the id of this LogAnalyticsConfigWorkRequestSummary. - workrequest id + The workrequest unique identifier. :param id: The id of this LogAnalyticsConfigWorkRequestSummary. @@ -143,7 +143,7 @@ def id(self, id): def compartment_id(self): """ Gets the compartment_id of this LogAnalyticsConfigWorkRequestSummary. - compartment id + The compartment unique identifier. :return: The compartment_id of this LogAnalyticsConfigWorkRequestSummary. @@ -155,7 +155,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this LogAnalyticsConfigWorkRequestSummary. - compartment id + The compartment unique identifier. :param compartment_id: The compartment_id of this LogAnalyticsConfigWorkRequestSummary. @@ -167,7 +167,9 @@ def compartment_id(self, compartment_id): def operation_type(self): """ Gets the operation_type of this LogAnalyticsConfigWorkRequestSummary. - operation type + The operation type. There are two classes of operations, association operations and + lookup operations. Associations may be created or deleted, and lookup operations include + append, update and delete. Allowed values for this property are: "CREATE_ASSOCIATIONS", "DELETE_ASSOCIATIONS", "APPEND_LOOKUP_DATA", "UPDATE_LOOKUP_DATA", "DELETE_LOOKUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -182,7 +184,9 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this LogAnalyticsConfigWorkRequestSummary. - operation type + The operation type. There are two classes of operations, association operations and + lookup operations. Associations may be created or deleted, and lookup operations include + append, update and delete. :param operation_type: The operation_type of this LogAnalyticsConfigWorkRequestSummary. @@ -197,7 +201,7 @@ def operation_type(self, operation_type): def percent_complete(self): """ Gets the percent_complete of this LogAnalyticsConfigWorkRequestSummary. - percentage complete + The completion percentage. :return: The percent_complete of this LogAnalyticsConfigWorkRequestSummary. @@ -209,7 +213,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this LogAnalyticsConfigWorkRequestSummary. - percentage complete + The completion percentage. :param percent_complete: The percent_complete of this LogAnalyticsConfigWorkRequestSummary. @@ -221,7 +225,7 @@ def percent_complete(self, percent_complete): def time_finished(self): """ Gets the time_finished of this LogAnalyticsConfigWorkRequestSummary. - when the work request finished + The time at which the work request finished. :return: The time_finished of this LogAnalyticsConfigWorkRequestSummary. @@ -233,7 +237,7 @@ def time_finished(self): def time_finished(self, time_finished): """ Sets the time_finished of this LogAnalyticsConfigWorkRequestSummary. - when the work request finished + The time at which the work request finished. :param time_finished: The time_finished of this LogAnalyticsConfigWorkRequestSummary. @@ -245,7 +249,7 @@ def time_finished(self, time_finished): def time_accepted(self): """ Gets the time_accepted of this LogAnalyticsConfigWorkRequestSummary. - when the work request accepted + The time at which the work request was accepted. :return: The time_accepted of this LogAnalyticsConfigWorkRequestSummary. @@ -257,7 +261,7 @@ def time_accepted(self): def time_accepted(self, time_accepted): """ Sets the time_accepted of this LogAnalyticsConfigWorkRequestSummary. - when the work request accepted + The time at which the work request was accepted. :param time_accepted: The time_accepted of this LogAnalyticsConfigWorkRequestSummary. @@ -269,7 +273,8 @@ def time_accepted(self, time_accepted): def lifecycle_state(self): """ Gets the lifecycle_state of this LogAnalyticsConfigWorkRequestSummary. - status + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED. Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -284,7 +289,8 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this LogAnalyticsConfigWorkRequestSummary. - status + The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED + or FAILED. :param lifecycle_state: The lifecycle_state of this LogAnalyticsConfigWorkRequestSummary. diff --git a/src/oci/log_analytics/models/log_analytics_em_bridge.py b/src/oci/log_analytics/models/log_analytics_em_bridge.py new file mode 100644 index 0000000000..21a7a97bfb --- /dev/null +++ b/src/oci/log_analytics/models/log_analytics_em_bridge.py @@ -0,0 +1,597 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LogAnalyticsEmBridge(object): + """ + Configuration details for enterprise manager bridge. + """ + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridge. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridge. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridge. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridge. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridge. + #: This constant has a value of "NOT_STARTED" + LAST_IMPORT_PROCESSING_STATUS_NOT_STARTED = "NOT_STARTED" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridge. + #: This constant has a value of "SUCCESS" + LAST_IMPORT_PROCESSING_STATUS_SUCCESS = "SUCCESS" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridge. + #: This constant has a value of "IN_PROGRESS" + LAST_IMPORT_PROCESSING_STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridge. + #: This constant has a value of "FAILED" + LAST_IMPORT_PROCESSING_STATUS_FAILED = "FAILED" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridge. + #: This constant has a value of "PARTIAL_SUCCESS" + LAST_IMPORT_PROCESSING_STATUS_PARTIAL_SUCCESS = "PARTIAL_SUCCESS" + + def __init__(self, **kwargs): + """ + Initializes a new LogAnalyticsEmBridge 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 LogAnalyticsEmBridge. + :type id: str + + :param display_name: + The value to assign to the display_name property of this LogAnalyticsEmBridge. + :type display_name: str + + :param description: + The value to assign to the description property of this LogAnalyticsEmBridge. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this LogAnalyticsEmBridge. + :type compartment_id: str + + :param em_entities_compartment_id: + The value to assign to the em_entities_compartment_id property of this LogAnalyticsEmBridge. + :type em_entities_compartment_id: str + + :param bucket_name: + The value to assign to the bucket_name property of this LogAnalyticsEmBridge. + :type bucket_name: str + + :param time_created: + The value to assign to the time_created property of this LogAnalyticsEmBridge. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this LogAnalyticsEmBridge. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this LogAnalyticsEmBridge. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this LogAnalyticsEmBridge. + :type lifecycle_details: str + + :param last_import_processing_status: + The value to assign to the last_import_processing_status property of this LogAnalyticsEmBridge. + Allowed values for this property are: "NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type last_import_processing_status: str + + :param last_import_processing_details: + The value to assign to the last_import_processing_details property of this LogAnalyticsEmBridge. + :type last_import_processing_details: str + + :param time_import_last_processed: + The value to assign to the time_import_last_processed property of this LogAnalyticsEmBridge. + :type time_import_last_processed: datetime + + :param time_em_data_last_extracted: + The value to assign to the time_em_data_last_extracted property of this LogAnalyticsEmBridge. + :type time_em_data_last_extracted: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this LogAnalyticsEmBridge. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this LogAnalyticsEmBridge. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'em_entities_compartment_id': 'str', + 'bucket_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'last_import_processing_status': 'str', + 'last_import_processing_details': 'str', + 'time_import_last_processed': 'datetime', + 'time_em_data_last_extracted': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'em_entities_compartment_id': 'emEntitiesCompartmentId', + 'bucket_name': 'bucketName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'last_import_processing_status': 'lastImportProcessingStatus', + 'last_import_processing_details': 'lastImportProcessingDetails', + 'time_import_last_processed': 'timeImportLastProcessed', + 'time_em_data_last_extracted': 'timeEmDataLastExtracted', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._em_entities_compartment_id = None + self._bucket_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._last_import_processing_status = None + self._last_import_processing_details = None + self._time_import_last_processed = None + self._time_em_data_last_extracted = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this LogAnalyticsEmBridge. + The enterprise manager bridge OCID. + + + :return: The id of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this LogAnalyticsEmBridge. + The enterprise manager bridge OCID. + + + :param id: The id of this LogAnalyticsEmBridge. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this LogAnalyticsEmBridge. + Log analytics enterprise manager bridge display name. + + + :return: The display_name of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this LogAnalyticsEmBridge. + Log analytics enterprise manager bridge display name. + + + :param display_name: The display_name of this LogAnalyticsEmBridge. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this LogAnalyticsEmBridge. + A description for log analytics enterprise manager bridge. + + + :return: The description of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this LogAnalyticsEmBridge. + A description for log analytics enterprise manager bridge. + + + :param description: The description of this LogAnalyticsEmBridge. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this LogAnalyticsEmBridge. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this LogAnalyticsEmBridge. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this LogAnalyticsEmBridge. + :type: str + """ + self._compartment_id = compartment_id + + @property + def em_entities_compartment_id(self): + """ + **[Required]** Gets the em_entities_compartment_id of this LogAnalyticsEmBridge. + Compartment for entities created from enterprise manager. + + + :return: The em_entities_compartment_id of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._em_entities_compartment_id + + @em_entities_compartment_id.setter + def em_entities_compartment_id(self, em_entities_compartment_id): + """ + Sets the em_entities_compartment_id of this LogAnalyticsEmBridge. + Compartment for entities created from enterprise manager. + + + :param em_entities_compartment_id: The em_entities_compartment_id of this LogAnalyticsEmBridge. + :type: str + """ + self._em_entities_compartment_id = em_entities_compartment_id + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this LogAnalyticsEmBridge. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :return: The bucket_name of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this LogAnalyticsEmBridge. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :param bucket_name: The bucket_name of this LogAnalyticsEmBridge. + :type: str + """ + self._bucket_name = bucket_name + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this LogAnalyticsEmBridge. + The date and time the resource was created, in the format defined by RFC3339. + + + :return: The time_created of this LogAnalyticsEmBridge. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this LogAnalyticsEmBridge. + The date and time the resource was created, in the format defined by RFC3339. + + + :param time_created: The time_created of this LogAnalyticsEmBridge. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this LogAnalyticsEmBridge. + The date and time the resource was last updated, in the format defined by RFC3339. + + + :return: The time_updated of this LogAnalyticsEmBridge. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this LogAnalyticsEmBridge. + The date and time the resource was last updated, in the format defined by RFC3339. + + + :param time_updated: The time_updated of this LogAnalyticsEmBridge. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this LogAnalyticsEmBridge. + The current state of the enterprise manager bridge. + + Allowed values for this property are: "CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this LogAnalyticsEmBridge. + The current state of the enterprise manager bridge. + + + :param lifecycle_state: The lifecycle_state of this LogAnalyticsEmBridge. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this LogAnalyticsEmBridge. + lifecycleDetails has additional information regarding substeps such as verifying connection to object store. + + + :return: The lifecycle_details of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this LogAnalyticsEmBridge. + lifecycleDetails has additional information regarding substeps such as verifying connection to object store. + + + :param lifecycle_details: The lifecycle_details of this LogAnalyticsEmBridge. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def last_import_processing_status(self): + """ + **[Required]** Gets the last_import_processing_status of this LogAnalyticsEmBridge. + The status from last processing status of enterprise manager upload. + + Allowed values for this property are: "NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The last_import_processing_status of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._last_import_processing_status + + @last_import_processing_status.setter + def last_import_processing_status(self, last_import_processing_status): + """ + Sets the last_import_processing_status of this LogAnalyticsEmBridge. + The status from last processing status of enterprise manager upload. + + + :param last_import_processing_status: The last_import_processing_status of this LogAnalyticsEmBridge. + :type: str + """ + allowed_values = ["NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS"] + if not value_allowed_none_or_none_sentinel(last_import_processing_status, allowed_values): + last_import_processing_status = 'UNKNOWN_ENUM_VALUE' + self._last_import_processing_status = last_import_processing_status + + @property + def last_import_processing_details(self): + """ + Gets the last_import_processing_details of this LogAnalyticsEmBridge. + Processing status details of enterprise manager upload. This provides additional details + for failed status + + + :return: The last_import_processing_details of this LogAnalyticsEmBridge. + :rtype: str + """ + return self._last_import_processing_details + + @last_import_processing_details.setter + def last_import_processing_details(self, last_import_processing_details): + """ + Sets the last_import_processing_details of this LogAnalyticsEmBridge. + Processing status details of enterprise manager upload. This provides additional details + for failed status + + + :param last_import_processing_details: The last_import_processing_details of this LogAnalyticsEmBridge. + :type: str + """ + self._last_import_processing_details = last_import_processing_details + + @property + def time_import_last_processed(self): + """ + Gets the time_import_last_processed of this LogAnalyticsEmBridge. + The last time of enterprise manager upload was processed. This is in the format defined by RFC3339 + + + :return: The time_import_last_processed of this LogAnalyticsEmBridge. + :rtype: datetime + """ + return self._time_import_last_processed + + @time_import_last_processed.setter + def time_import_last_processed(self, time_import_last_processed): + """ + Sets the time_import_last_processed of this LogAnalyticsEmBridge. + The last time of enterprise manager upload was processed. This is in the format defined by RFC3339 + + + :param time_import_last_processed: The time_import_last_processed of this LogAnalyticsEmBridge. + :type: datetime + """ + self._time_import_last_processed = time_import_last_processed + + @property + def time_em_data_last_extracted(self): + """ + Gets the time_em_data_last_extracted of this LogAnalyticsEmBridge. + The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339 + + + :return: The time_em_data_last_extracted of this LogAnalyticsEmBridge. + :rtype: datetime + """ + return self._time_em_data_last_extracted + + @time_em_data_last_extracted.setter + def time_em_data_last_extracted(self, time_em_data_last_extracted): + """ + Sets the time_em_data_last_extracted of this LogAnalyticsEmBridge. + The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339 + + + :param time_em_data_last_extracted: The time_em_data_last_extracted of this LogAnalyticsEmBridge. + :type: datetime + """ + self._time_em_data_last_extracted = time_em_data_last_extracted + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this LogAnalyticsEmBridge. + 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 LogAnalyticsEmBridge. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this LogAnalyticsEmBridge. + 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 LogAnalyticsEmBridge. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this LogAnalyticsEmBridge. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this LogAnalyticsEmBridge. + :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 LogAnalyticsEmBridge. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this LogAnalyticsEmBridge. + :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/log_analytics/models/log_analytics_em_bridge_collection.py b/src/oci/log_analytics/models/log_analytics_em_bridge_collection.py new file mode 100644 index 0000000000..346a08b216 --- /dev/null +++ b/src/oci/log_analytics/models/log_analytics_em_bridge_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LogAnalyticsEmBridgeCollection(object): + """ + Collection of log analytics enterprise manager bridges. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LogAnalyticsEmBridgeCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this LogAnalyticsEmBridgeCollection. + :type items: list[oci.log_analytics.models.LogAnalyticsEmBridgeSummary] + + """ + self.swagger_types = { + 'items': 'list[LogAnalyticsEmBridgeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this LogAnalyticsEmBridgeCollection. + Array of log analytics enterprise manager bridges. + + + :return: The items of this LogAnalyticsEmBridgeCollection. + :rtype: list[oci.log_analytics.models.LogAnalyticsEmBridgeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this LogAnalyticsEmBridgeCollection. + Array of log analytics enterprise manager bridges. + + + :param items: The items of this LogAnalyticsEmBridgeCollection. + :type: list[oci.log_analytics.models.LogAnalyticsEmBridgeSummary] + """ + self._items = items + + 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/log_analytics/models/log_analytics_em_bridge_summary.py b/src/oci/log_analytics/models/log_analytics_em_bridge_summary.py new file mode 100644 index 0000000000..43f9db13fb --- /dev/null +++ b/src/oci/log_analytics/models/log_analytics_em_bridge_summary.py @@ -0,0 +1,597 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LogAnalyticsEmBridgeSummary(object): + """ + Enterprise manager bridge summary. + """ + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "NOT_STARTED" + LAST_IMPORT_PROCESSING_STATUS_NOT_STARTED = "NOT_STARTED" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "SUCCESS" + LAST_IMPORT_PROCESSING_STATUS_SUCCESS = "SUCCESS" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "IN_PROGRESS" + LAST_IMPORT_PROCESSING_STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "FAILED" + LAST_IMPORT_PROCESSING_STATUS_FAILED = "FAILED" + + #: A constant which can be used with the last_import_processing_status property of a LogAnalyticsEmBridgeSummary. + #: This constant has a value of "PARTIAL_SUCCESS" + LAST_IMPORT_PROCESSING_STATUS_PARTIAL_SUCCESS = "PARTIAL_SUCCESS" + + def __init__(self, **kwargs): + """ + Initializes a new LogAnalyticsEmBridgeSummary 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 LogAnalyticsEmBridgeSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this LogAnalyticsEmBridgeSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this LogAnalyticsEmBridgeSummary. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this LogAnalyticsEmBridgeSummary. + :type compartment_id: str + + :param em_entities_compartment_id: + The value to assign to the em_entities_compartment_id property of this LogAnalyticsEmBridgeSummary. + :type em_entities_compartment_id: str + + :param bucket_name: + The value to assign to the bucket_name property of this LogAnalyticsEmBridgeSummary. + :type bucket_name: str + + :param time_created: + The value to assign to the time_created property of this LogAnalyticsEmBridgeSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this LogAnalyticsEmBridgeSummary. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this LogAnalyticsEmBridgeSummary. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this LogAnalyticsEmBridgeSummary. + :type lifecycle_details: str + + :param last_import_processing_status: + The value to assign to the last_import_processing_status property of this LogAnalyticsEmBridgeSummary. + Allowed values for this property are: "NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type last_import_processing_status: str + + :param last_import_processing_details: + The value to assign to the last_import_processing_details property of this LogAnalyticsEmBridgeSummary. + :type last_import_processing_details: str + + :param time_import_last_processed: + The value to assign to the time_import_last_processed property of this LogAnalyticsEmBridgeSummary. + :type time_import_last_processed: datetime + + :param time_em_data_last_extracted: + The value to assign to the time_em_data_last_extracted property of this LogAnalyticsEmBridgeSummary. + :type time_em_data_last_extracted: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this LogAnalyticsEmBridgeSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this LogAnalyticsEmBridgeSummary. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'em_entities_compartment_id': 'str', + 'bucket_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'last_import_processing_status': 'str', + 'last_import_processing_details': 'str', + 'time_import_last_processed': 'datetime', + 'time_em_data_last_extracted': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'em_entities_compartment_id': 'emEntitiesCompartmentId', + 'bucket_name': 'bucketName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'last_import_processing_status': 'lastImportProcessingStatus', + 'last_import_processing_details': 'lastImportProcessingDetails', + 'time_import_last_processed': 'timeImportLastProcessed', + 'time_em_data_last_extracted': 'timeEmDataLastExtracted', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._em_entities_compartment_id = None + self._bucket_name = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._lifecycle_details = None + self._last_import_processing_status = None + self._last_import_processing_details = None + self._time_import_last_processed = None + self._time_em_data_last_extracted = None + self._freeform_tags = None + self._defined_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this LogAnalyticsEmBridgeSummary. + The enterprise manager bridge OCID. + + + :return: The id of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this LogAnalyticsEmBridgeSummary. + The enterprise manager bridge OCID. + + + :param id: The id of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this LogAnalyticsEmBridgeSummary. + Log analytics enterprise manager bridge display name. + + + :return: The display_name of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this LogAnalyticsEmBridgeSummary. + Log analytics enterprise manager bridge display name. + + + :param display_name: The display_name of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this LogAnalyticsEmBridgeSummary. + A description for log analytics enterprise manager bridge. + + + :return: The description of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this LogAnalyticsEmBridgeSummary. + A description for log analytics enterprise manager bridge. + + + :param description: The description of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this LogAnalyticsEmBridgeSummary. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this LogAnalyticsEmBridgeSummary. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def em_entities_compartment_id(self): + """ + **[Required]** Gets the em_entities_compartment_id of this LogAnalyticsEmBridgeSummary. + Compartment for entities created from enterprise manager. + + + :return: The em_entities_compartment_id of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._em_entities_compartment_id + + @em_entities_compartment_id.setter + def em_entities_compartment_id(self, em_entities_compartment_id): + """ + Sets the em_entities_compartment_id of this LogAnalyticsEmBridgeSummary. + Compartment for entities created from enterprise manager. + + + :param em_entities_compartment_id: The em_entities_compartment_id of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._em_entities_compartment_id = em_entities_compartment_id + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this LogAnalyticsEmBridgeSummary. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :return: The bucket_name of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this LogAnalyticsEmBridgeSummary. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :param bucket_name: The bucket_name of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._bucket_name = bucket_name + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this LogAnalyticsEmBridgeSummary. + The date and time the resource was created, in the format defined by RFC3339. + + + :return: The time_created of this LogAnalyticsEmBridgeSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this LogAnalyticsEmBridgeSummary. + The date and time the resource was created, in the format defined by RFC3339. + + + :param time_created: The time_created of this LogAnalyticsEmBridgeSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this LogAnalyticsEmBridgeSummary. + The date and time the resource was last updated, in the format defined by RFC3339. + + + :return: The time_updated of this LogAnalyticsEmBridgeSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this LogAnalyticsEmBridgeSummary. + The date and time the resource was last updated, in the format defined by RFC3339. + + + :param time_updated: The time_updated of this LogAnalyticsEmBridgeSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this LogAnalyticsEmBridgeSummary. + The current state of the enterprise manager bridge. + + Allowed values for this property are: "CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this LogAnalyticsEmBridgeSummary. + The current state of the enterprise manager bridge. + + + :param lifecycle_state: The lifecycle_state of this LogAnalyticsEmBridgeSummary. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "DELETED", "NEEDS_ATTENTION"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this LogAnalyticsEmBridgeSummary. + lifecycleDetails has additional information regarding substeps such as verifying connection to object store. + + + :return: The lifecycle_details of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this LogAnalyticsEmBridgeSummary. + lifecycleDetails has additional information regarding substeps such as verifying connection to object store. + + + :param lifecycle_details: The lifecycle_details of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def last_import_processing_status(self): + """ + **[Required]** Gets the last_import_processing_status of this LogAnalyticsEmBridgeSummary. + The status from last processing status of enterprise manager upload. + + Allowed values for this property are: "NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The last_import_processing_status of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._last_import_processing_status + + @last_import_processing_status.setter + def last_import_processing_status(self, last_import_processing_status): + """ + Sets the last_import_processing_status of this LogAnalyticsEmBridgeSummary. + The status from last processing status of enterprise manager upload. + + + :param last_import_processing_status: The last_import_processing_status of this LogAnalyticsEmBridgeSummary. + :type: str + """ + allowed_values = ["NOT_STARTED", "SUCCESS", "IN_PROGRESS", "FAILED", "PARTIAL_SUCCESS"] + if not value_allowed_none_or_none_sentinel(last_import_processing_status, allowed_values): + last_import_processing_status = 'UNKNOWN_ENUM_VALUE' + self._last_import_processing_status = last_import_processing_status + + @property + def last_import_processing_details(self): + """ + Gets the last_import_processing_details of this LogAnalyticsEmBridgeSummary. + Processing status details of enterprise manager upload. This provides additional details + for failed status + + + :return: The last_import_processing_details of this LogAnalyticsEmBridgeSummary. + :rtype: str + """ + return self._last_import_processing_details + + @last_import_processing_details.setter + def last_import_processing_details(self, last_import_processing_details): + """ + Sets the last_import_processing_details of this LogAnalyticsEmBridgeSummary. + Processing status details of enterprise manager upload. This provides additional details + for failed status + + + :param last_import_processing_details: The last_import_processing_details of this LogAnalyticsEmBridgeSummary. + :type: str + """ + self._last_import_processing_details = last_import_processing_details + + @property + def time_import_last_processed(self): + """ + Gets the time_import_last_processed of this LogAnalyticsEmBridgeSummary. + The last time of enterprise manager upload was processed. This is in the format defined by RFC3339 + + + :return: The time_import_last_processed of this LogAnalyticsEmBridgeSummary. + :rtype: datetime + """ + return self._time_import_last_processed + + @time_import_last_processed.setter + def time_import_last_processed(self, time_import_last_processed): + """ + Sets the time_import_last_processed of this LogAnalyticsEmBridgeSummary. + The last time of enterprise manager upload was processed. This is in the format defined by RFC3339 + + + :param time_import_last_processed: The time_import_last_processed of this LogAnalyticsEmBridgeSummary. + :type: datetime + """ + self._time_import_last_processed = time_import_last_processed + + @property + def time_em_data_last_extracted(self): + """ + Gets the time_em_data_last_extracted of this LogAnalyticsEmBridgeSummary. + The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339 + + + :return: The time_em_data_last_extracted of this LogAnalyticsEmBridgeSummary. + :rtype: datetime + """ + return self._time_em_data_last_extracted + + @time_em_data_last_extracted.setter + def time_em_data_last_extracted(self, time_em_data_last_extracted): + """ + Sets the time_em_data_last_extracted of this LogAnalyticsEmBridgeSummary. + The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339 + + + :param time_em_data_last_extracted: The time_em_data_last_extracted of this LogAnalyticsEmBridgeSummary. + :type: datetime + """ + self._time_em_data_last_extracted = time_em_data_last_extracted + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this LogAnalyticsEmBridgeSummary. + 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 LogAnalyticsEmBridgeSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this LogAnalyticsEmBridgeSummary. + 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 LogAnalyticsEmBridgeSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this LogAnalyticsEmBridgeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this LogAnalyticsEmBridgeSummary. + :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 LogAnalyticsEmBridgeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this LogAnalyticsEmBridgeSummary. + :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/log_analytics/models/log_analytics_em_bridge_summary_report.py b/src/oci/log_analytics/models/log_analytics_em_bridge_summary_report.py new file mode 100644 index 0000000000..65c1ac5a3e --- /dev/null +++ b/src/oci/log_analytics/models/log_analytics_em_bridge_summary_report.py @@ -0,0 +1,229 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LogAnalyticsEmBridgeSummaryReport(object): + """ + Log-Analytics EM Bridge counts summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LogAnalyticsEmBridgeSummaryReport 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 LogAnalyticsEmBridgeSummaryReport. + :type compartment_id: str + + :param active_em_bridge_count: + The value to assign to the active_em_bridge_count property of this LogAnalyticsEmBridgeSummaryReport. + :type active_em_bridge_count: int + + :param creating_em_bridge_count: + The value to assign to the creating_em_bridge_count property of this LogAnalyticsEmBridgeSummaryReport. + :type creating_em_bridge_count: int + + :param needs_attention_em_bridge_count: + The value to assign to the needs_attention_em_bridge_count property of this LogAnalyticsEmBridgeSummaryReport. + :type needs_attention_em_bridge_count: int + + :param deleted_em_bridge_count: + The value to assign to the deleted_em_bridge_count property of this LogAnalyticsEmBridgeSummaryReport. + :type deleted_em_bridge_count: int + + :param total_em_bridge_count: + The value to assign to the total_em_bridge_count property of this LogAnalyticsEmBridgeSummaryReport. + :type total_em_bridge_count: int + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'active_em_bridge_count': 'int', + 'creating_em_bridge_count': 'int', + 'needs_attention_em_bridge_count': 'int', + 'deleted_em_bridge_count': 'int', + 'total_em_bridge_count': 'int' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'active_em_bridge_count': 'activeEmBridgeCount', + 'creating_em_bridge_count': 'creatingEmBridgeCount', + 'needs_attention_em_bridge_count': 'needsAttentionEmBridgeCount', + 'deleted_em_bridge_count': 'deletedEmBridgeCount', + 'total_em_bridge_count': 'totalEmBridgeCount' + } + + self._compartment_id = None + self._active_em_bridge_count = None + self._creating_em_bridge_count = None + self._needs_attention_em_bridge_count = None + self._deleted_em_bridge_count = None + self._total_em_bridge_count = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this LogAnalyticsEmBridgeSummaryReport. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this LogAnalyticsEmBridgeSummaryReport. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this LogAnalyticsEmBridgeSummaryReport. + Compartment Identifier `OCID]`__. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this LogAnalyticsEmBridgeSummaryReport. + :type: str + """ + self._compartment_id = compartment_id + + @property + def active_em_bridge_count(self): + """ + **[Required]** Gets the active_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Total number of ACTIVE enterprise manager bridges. + + + :return: The active_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :rtype: int + """ + return self._active_em_bridge_count + + @active_em_bridge_count.setter + def active_em_bridge_count(self, active_em_bridge_count): + """ + Sets the active_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Total number of ACTIVE enterprise manager bridges. + + + :param active_em_bridge_count: The active_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :type: int + """ + self._active_em_bridge_count = active_em_bridge_count + + @property + def creating_em_bridge_count(self): + """ + **[Required]** Gets the creating_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in CREATING state. + + + :return: The creating_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :rtype: int + """ + return self._creating_em_bridge_count + + @creating_em_bridge_count.setter + def creating_em_bridge_count(self, creating_em_bridge_count): + """ + Sets the creating_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in CREATING state. + + + :param creating_em_bridge_count: The creating_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :type: int + """ + self._creating_em_bridge_count = creating_em_bridge_count + + @property + def needs_attention_em_bridge_count(self): + """ + **[Required]** Gets the needs_attention_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in NEEDS_ATTENTION state. + + + :return: The needs_attention_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :rtype: int + """ + return self._needs_attention_em_bridge_count + + @needs_attention_em_bridge_count.setter + def needs_attention_em_bridge_count(self, needs_attention_em_bridge_count): + """ + Sets the needs_attention_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in NEEDS_ATTENTION state. + + + :param needs_attention_em_bridge_count: The needs_attention_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :type: int + """ + self._needs_attention_em_bridge_count = needs_attention_em_bridge_count + + @property + def deleted_em_bridge_count(self): + """ + **[Required]** Gets the deleted_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in DELETED state. + + + :return: The deleted_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :rtype: int + """ + return self._deleted_em_bridge_count + + @deleted_em_bridge_count.setter + def deleted_em_bridge_count(self, deleted_em_bridge_count): + """ + Sets the deleted_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Number of enterprise manager bridges in DELETED state. + + + :param deleted_em_bridge_count: The deleted_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :type: int + """ + self._deleted_em_bridge_count = deleted_em_bridge_count + + @property + def total_em_bridge_count(self): + """ + **[Required]** Gets the total_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Total number of enterprise manager bridges. + + + :return: The total_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :rtype: int + """ + return self._total_em_bridge_count + + @total_em_bridge_count.setter + def total_em_bridge_count(self, total_em_bridge_count): + """ + Sets the total_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + Total number of enterprise manager bridges. + + + :param total_em_bridge_count: The total_em_bridge_count of this LogAnalyticsEmBridgeSummaryReport. + :type: int + """ + self._total_em_bridge_count = total_em_bridge_count + + 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/log_analytics/models/log_analytics_entity.py b/src/oci/log_analytics/models/log_analytics_entity.py index 13130dacf3..fcbf84d7c6 100644 --- a/src/oci/log_analytics/models/log_analytics_entity.py +++ b/src/oci/log_analytics/models/log_analytics_entity.py @@ -76,6 +76,10 @@ def __init__(self, **kwargs): The value to assign to the properties property of this LogAnalyticsEntity. :type properties: dict(str, str) + :param creation_source: + The value to assign to the creation_source property of this LogAnalyticsEntity. + :type creation_source: oci.log_analytics.models.CreationSource + :param time_created: The value to assign to the time_created property of this LogAnalyticsEntity. :type time_created: datetime @@ -122,6 +126,7 @@ def __init__(self, **kwargs): 'management_agent_compartment_id': 'str', 'timezone_region': 'str', 'properties': 'dict(str, str)', + 'creation_source': 'CreationSource', 'time_created': 'datetime', 'time_updated': 'datetime', 'are_logs_collected': 'bool', @@ -145,6 +150,7 @@ def __init__(self, **kwargs): 'management_agent_compartment_id': 'managementAgentCompartmentId', 'timezone_region': 'timezoneRegion', 'properties': 'properties', + 'creation_source': 'creationSource', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'are_logs_collected': 'areLogsCollected', @@ -167,6 +173,7 @@ def __init__(self, **kwargs): self._management_agent_compartment_id = None self._timezone_region = None self._properties = None + self._creation_source = None self._time_created = None self._time_updated = None self._are_logs_collected = None @@ -476,6 +483,26 @@ def properties(self, properties): """ self._properties = properties + @property + def creation_source(self): + """ + Gets the creation_source of this LogAnalyticsEntity. + + :return: The creation_source of this LogAnalyticsEntity. + :rtype: oci.log_analytics.models.CreationSource + """ + return self._creation_source + + @creation_source.setter + def creation_source(self, creation_source): + """ + Sets the creation_source of this LogAnalyticsEntity. + + :param creation_source: The creation_source of this LogAnalyticsEntity. + :type: oci.log_analytics.models.CreationSource + """ + self._creation_source = creation_source + @property def time_created(self): """ diff --git a/src/oci/log_analytics/models/log_analytics_entity_summary.py b/src/oci/log_analytics/models/log_analytics_entity_summary.py index 375813e6e0..c6cc8191d9 100644 --- a/src/oci/log_analytics/models/log_analytics_entity_summary.py +++ b/src/oci/log_analytics/models/log_analytics_entity_summary.py @@ -84,6 +84,10 @@ def __init__(self, **kwargs): The value to assign to the source_id property of this LogAnalyticsEntitySummary. :type source_id: str + :param creation_source: + The value to assign to the creation_source property of this LogAnalyticsEntitySummary. + :type creation_source: oci.log_analytics.models.CreationSource + :param freeform_tags: The value to assign to the freeform_tags property of this LogAnalyticsEntitySummary. :type freeform_tags: dict(str, str) @@ -108,6 +112,7 @@ def __init__(self, **kwargs): 'time_updated': 'datetime', 'are_logs_collected': 'bool', 'source_id': 'str', + 'creation_source': 'CreationSource', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -127,6 +132,7 @@ def __init__(self, **kwargs): 'time_updated': 'timeUpdated', 'are_logs_collected': 'areLogsCollected', 'source_id': 'sourceId', + 'creation_source': 'creationSource', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } @@ -145,6 +151,7 @@ def __init__(self, **kwargs): self._time_updated = None self._are_logs_collected = None self._source_id = None + self._creation_source = None self._freeform_tags = None self._defined_tags = None @@ -498,6 +505,26 @@ def source_id(self, source_id): """ self._source_id = source_id + @property + def creation_source(self): + """ + Gets the creation_source of this LogAnalyticsEntitySummary. + + :return: The creation_source of this LogAnalyticsEntitySummary. + :rtype: oci.log_analytics.models.CreationSource + """ + return self._creation_source + + @creation_source.setter + def creation_source(self, creation_source): + """ + Sets the creation_source of this LogAnalyticsEntitySummary. + + :param creation_source: The creation_source of this LogAnalyticsEntitySummary. + :type: oci.log_analytics.models.CreationSource + """ + self._creation_source = creation_source + @property def freeform_tags(self): """ diff --git a/src/oci/log_analytics/models/log_analytics_entity_type.py b/src/oci/log_analytics/models/log_analytics_entity_type.py index 109834f902..4f5fe45812 100644 --- a/src/oci/log_analytics/models/log_analytics_entity_type.py +++ b/src/oci/log_analytics/models/log_analytics_entity_type.py @@ -21,6 +21,10 @@ class LogAnalyticsEntityType(object): #: This constant has a value of "NON_CLOUD" CLOUD_TYPE_NON_CLOUD = "NON_CLOUD" + #: A constant which can be used with the cloud_type property of a LogAnalyticsEntityType. + #: This constant has a value of "ALL" + CLOUD_TYPE_ALL = "ALL" + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEntityType. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" @@ -29,6 +33,18 @@ class LogAnalyticsEntityType(object): #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityType. + #: This constant has a value of "ELIGIBLE" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_ELIGIBLE = "ELIGIBLE" + + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityType. + #: This constant has a value of "INELIGIBLE" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_INELIGIBLE = "INELIGIBLE" + + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityType. + #: This constant has a value of "UNKNOWN" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_UNKNOWN = "UNKNOWN" + def __init__(self, **kwargs): """ Initializes a new LogAnalyticsEntityType object with values from keyword arguments. @@ -52,7 +68,7 @@ def __init__(self, **kwargs): :param cloud_type: The value to assign to the cloud_type property of this LogAnalyticsEntityType. - Allowed values for this property are: "CLOUD", "NON_CLOUD", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CLOUD", "NON_CLOUD", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type cloud_type: str @@ -74,6 +90,12 @@ def __init__(self, **kwargs): The value to assign to the time_updated property of this LogAnalyticsEntityType. :type time_updated: datetime + :param management_agent_eligibility_status: + The value to assign to the management_agent_eligibility_status property of this LogAnalyticsEntityType. + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type management_agent_eligibility_status: str + """ self.swagger_types = { 'name': 'str', @@ -84,7 +106,8 @@ def __init__(self, **kwargs): 'properties': 'list[EntityTypeProperty]', 'lifecycle_state': 'str', 'time_created': 'datetime', - 'time_updated': 'datetime' + 'time_updated': 'datetime', + 'management_agent_eligibility_status': 'str' } self.attribute_map = { @@ -96,7 +119,8 @@ def __init__(self, **kwargs): 'properties': 'properties', 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', - 'time_updated': 'timeUpdated' + 'time_updated': 'timeUpdated', + 'management_agent_eligibility_status': 'managementAgentEligibilityStatus' } self._name = None @@ -108,6 +132,7 @@ def __init__(self, **kwargs): self._lifecycle_state = None self._time_created = None self._time_updated = None + self._management_agent_eligibility_status = None @property def name(self): @@ -215,7 +240,7 @@ def cloud_type(self): **[Required]** Gets the cloud_type of this LogAnalyticsEntityType. Log analytics entity type group. That can be CLOUD (OCI) or NON_CLOUD otherwise. - Allowed values for this property are: "CLOUD", "NON_CLOUD", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CLOUD", "NON_CLOUD", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -234,7 +259,7 @@ def cloud_type(self, cloud_type): :param cloud_type: The cloud_type of this LogAnalyticsEntityType. :type: str """ - allowed_values = ["CLOUD", "NON_CLOUD"] + allowed_values = ["CLOUD", "NON_CLOUD", "ALL"] if not value_allowed_none_or_none_sentinel(cloud_type, allowed_values): cloud_type = 'UNKNOWN_ENUM_VALUE' self._cloud_type = cloud_type @@ -341,6 +366,36 @@ def time_updated(self, time_updated): """ self._time_updated = time_updated + @property + def management_agent_eligibility_status(self): + """ + Gets the management_agent_eligibility_status of this LogAnalyticsEntityType. + This field indicates whether logs for entities of this type can be collected using a management agent. + + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The management_agent_eligibility_status of this LogAnalyticsEntityType. + :rtype: str + """ + return self._management_agent_eligibility_status + + @management_agent_eligibility_status.setter + def management_agent_eligibility_status(self, management_agent_eligibility_status): + """ + Sets the management_agent_eligibility_status of this LogAnalyticsEntityType. + This field indicates whether logs for entities of this type can be collected using a management agent. + + + :param management_agent_eligibility_status: The management_agent_eligibility_status of this LogAnalyticsEntityType. + :type: str + """ + allowed_values = ["ELIGIBLE", "INELIGIBLE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(management_agent_eligibility_status, allowed_values): + management_agent_eligibility_status = 'UNKNOWN_ENUM_VALUE' + self._management_agent_eligibility_status = management_agent_eligibility_status + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/log_analytics_entity_type_summary.py b/src/oci/log_analytics/models/log_analytics_entity_type_summary.py index d43c3fa2b9..6dcea2461d 100644 --- a/src/oci/log_analytics/models/log_analytics_entity_type_summary.py +++ b/src/oci/log_analytics/models/log_analytics_entity_type_summary.py @@ -21,6 +21,10 @@ class LogAnalyticsEntityTypeSummary(object): #: This constant has a value of "NON_CLOUD" CLOUD_TYPE_NON_CLOUD = "NON_CLOUD" + #: A constant which can be used with the cloud_type property of a LogAnalyticsEntityTypeSummary. + #: This constant has a value of "ALL" + CLOUD_TYPE_ALL = "ALL" + #: A constant which can be used with the lifecycle_state property of a LogAnalyticsEntityTypeSummary. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" @@ -29,6 +33,18 @@ class LogAnalyticsEntityTypeSummary(object): #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityTypeSummary. + #: This constant has a value of "ELIGIBLE" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_ELIGIBLE = "ELIGIBLE" + + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityTypeSummary. + #: This constant has a value of "INELIGIBLE" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_INELIGIBLE = "INELIGIBLE" + + #: A constant which can be used with the management_agent_eligibility_status property of a LogAnalyticsEntityTypeSummary. + #: This constant has a value of "UNKNOWN" + MANAGEMENT_AGENT_ELIGIBILITY_STATUS_UNKNOWN = "UNKNOWN" + def __init__(self, **kwargs): """ Initializes a new LogAnalyticsEntityTypeSummary object with values from keyword arguments. @@ -48,7 +64,7 @@ def __init__(self, **kwargs): :param cloud_type: The value to assign to the cloud_type property of this LogAnalyticsEntityTypeSummary. - Allowed values for this property are: "CLOUD", "NON_CLOUD", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CLOUD", "NON_CLOUD", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type cloud_type: str @@ -66,6 +82,12 @@ def __init__(self, **kwargs): The value to assign to the time_updated property of this LogAnalyticsEntityTypeSummary. :type time_updated: datetime + :param management_agent_eligibility_status: + The value to assign to the management_agent_eligibility_status property of this LogAnalyticsEntityTypeSummary. + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type management_agent_eligibility_status: str + """ self.swagger_types = { 'name': 'str', @@ -74,7 +96,8 @@ def __init__(self, **kwargs): 'cloud_type': 'str', 'lifecycle_state': 'str', 'time_created': 'datetime', - 'time_updated': 'datetime' + 'time_updated': 'datetime', + 'management_agent_eligibility_status': 'str' } self.attribute_map = { @@ -84,7 +107,8 @@ def __init__(self, **kwargs): 'cloud_type': 'cloudType', 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', - 'time_updated': 'timeUpdated' + 'time_updated': 'timeUpdated', + 'management_agent_eligibility_status': 'managementAgentEligibilityStatus' } self._name = None @@ -94,6 +118,7 @@ def __init__(self, **kwargs): self._lifecycle_state = None self._time_created = None self._time_updated = None + self._management_agent_eligibility_status = None @property def name(self): @@ -173,7 +198,7 @@ def cloud_type(self): **[Required]** Gets the cloud_type of this LogAnalyticsEntityTypeSummary. Log analytics entity type group. This can be CLOUD (OCI) or NON_CLOUD otherwise. - Allowed values for this property are: "CLOUD", "NON_CLOUD", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CLOUD", "NON_CLOUD", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -192,7 +217,7 @@ def cloud_type(self, cloud_type): :param cloud_type: The cloud_type of this LogAnalyticsEntityTypeSummary. :type: str """ - allowed_values = ["CLOUD", "NON_CLOUD"] + allowed_values = ["CLOUD", "NON_CLOUD", "ALL"] if not value_allowed_none_or_none_sentinel(cloud_type, allowed_values): cloud_type = 'UNKNOWN_ENUM_VALUE' self._cloud_type = cloud_type @@ -275,6 +300,36 @@ def time_updated(self, time_updated): """ self._time_updated = time_updated + @property + def management_agent_eligibility_status(self): + """ + Gets the management_agent_eligibility_status of this LogAnalyticsEntityTypeSummary. + This field indicates whether logs for entities of this type can be collected using a management agent. + + Allowed values for this property are: "ELIGIBLE", "INELIGIBLE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The management_agent_eligibility_status of this LogAnalyticsEntityTypeSummary. + :rtype: str + """ + return self._management_agent_eligibility_status + + @management_agent_eligibility_status.setter + def management_agent_eligibility_status(self, management_agent_eligibility_status): + """ + Sets the management_agent_eligibility_status of this LogAnalyticsEntityTypeSummary. + This field indicates whether logs for entities of this type can be collected using a management agent. + + + :param management_agent_eligibility_status: The management_agent_eligibility_status of this LogAnalyticsEntityTypeSummary. + :type: str + """ + allowed_values = ["ELIGIBLE", "INELIGIBLE", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(management_agent_eligibility_status, allowed_values): + management_agent_eligibility_status = 'UNKNOWN_ENUM_VALUE' + self._management_agent_eligibility_status = management_agent_eligibility_status + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/log_analytics_extended_field.py b/src/oci/log_analytics/models/log_analytics_extended_field.py index c4e8ae253e..6cc596a669 100644 --- a/src/oci/log_analytics/models/log_analytics_extended_field.py +++ b/src/oci/log_analytics/models/log_analytics_extended_field.py @@ -119,7 +119,7 @@ def extended_field_definition(self, extended_field_definition): def extended_field_definition_id(self): """ Gets the extended_field_definition_id of this LogAnalyticsExtendedField. - Id + The extended field unique identifier. :return: The extended_field_definition_id of this LogAnalyticsExtendedField. @@ -131,7 +131,7 @@ def extended_field_definition_id(self): def extended_field_definition_id(self, extended_field_definition_id): """ Sets the extended_field_definition_id of this LogAnalyticsExtendedField. - Id + The extended field unique identifier. :param extended_field_definition_id: The extended_field_definition_id of this LogAnalyticsExtendedField. @@ -143,7 +143,7 @@ def extended_field_definition_id(self, extended_field_definition_id): def field_name(self): """ Gets the field_name of this LogAnalyticsExtendedField. - new field internal name + The field internal name :return: The field_name of this LogAnalyticsExtendedField. @@ -155,7 +155,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this LogAnalyticsExtendedField. - new field internal name + The field internal name :param field_name: The field_name of this LogAnalyticsExtendedField. @@ -167,7 +167,7 @@ def field_name(self, field_name): def field_display_name(self): """ Gets the field_display_name of this LogAnalyticsExtendedField. - new field internal display name + The field internal display name. :return: The field_display_name of this LogAnalyticsExtendedField. @@ -179,7 +179,7 @@ def field_display_name(self): def field_display_name(self, field_display_name): """ Sets the field_display_name of this LogAnalyticsExtendedField. - new field internal display name + The field internal display name. :param field_display_name: The field_display_name of this LogAnalyticsExtendedField. @@ -191,7 +191,7 @@ def field_display_name(self, field_display_name): def saved_regular_expression_name(self): """ Gets the saved_regular_expression_name of this LogAnalyticsExtendedField. - saved regular expression internal name + The saved regular expression name. :return: The saved_regular_expression_name of this LogAnalyticsExtendedField. @@ -203,7 +203,7 @@ def saved_regular_expression_name(self): def saved_regular_expression_name(self, saved_regular_expression_name): """ Sets the saved_regular_expression_name of this LogAnalyticsExtendedField. - saved regular expression internal name + The saved regular expression name. :param saved_regular_expression_name: The saved_regular_expression_name of this LogAnalyticsExtendedField. @@ -215,7 +215,7 @@ def saved_regular_expression_name(self, saved_regular_expression_name): def extended_field_id(self): """ Gets the extended_field_id of this LogAnalyticsExtendedField. - extended field Id + The extended field unique identifier. :return: The extended_field_id of this LogAnalyticsExtendedField. @@ -227,7 +227,7 @@ def extended_field_id(self): def extended_field_id(self, extended_field_id): """ Sets the extended_field_id of this LogAnalyticsExtendedField. - extended field Id + The extended field unique identifier. :param extended_field_id: The extended_field_id of this LogAnalyticsExtendedField. diff --git a/src/oci/log_analytics/models/log_analytics_field.py b/src/oci/log_analytics/models/log_analytics_field.py index 58f44d8ee8..bafd8f5266 100644 --- a/src/oci/log_analytics/models/log_analytics_field.py +++ b/src/oci/log_analytics/models/log_analytics_field.py @@ -203,7 +203,7 @@ def cee_alias(self, cee_alias): def data_type(self): """ Gets the data_type of this LogAnalyticsField. - data type + The field data type. :return: The data_type of this LogAnalyticsField. @@ -215,7 +215,7 @@ def data_type(self): def data_type(self, data_type): """ Sets the data_type of this LogAnalyticsField. - data type + The field data type. :param data_type: The data_type of this LogAnalyticsField. @@ -227,7 +227,7 @@ def data_type(self, data_type): def regular_expression(self): """ Gets the regular_expression of this LogAnalyticsField. - default regular expression + The field default regular expression. :return: The regular_expression of this LogAnalyticsField. @@ -239,7 +239,7 @@ def regular_expression(self): def regular_expression(self, regular_expression): """ Sets the regular_expression of this LogAnalyticsField. - default regular expression + The field default regular expression. :param regular_expression: The regular_expression of this LogAnalyticsField. @@ -251,7 +251,7 @@ def regular_expression(self, regular_expression): def description(self): """ Gets the description of this LogAnalyticsField. - description + The field description. :return: The description of this LogAnalyticsField. @@ -263,7 +263,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsField. - description + The field description. :param description: The description of this LogAnalyticsField. @@ -275,7 +275,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsField. - display name + The field display name. :return: The display_name of this LogAnalyticsField. @@ -287,7 +287,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsField. - display name + The field display name. :param display_name: The display_name of this LogAnalyticsField. @@ -299,7 +299,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsField. - edit version + The field edit version. :return: The edit_version of this LogAnalyticsField. @@ -311,7 +311,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsField. - edit version + The field edit version. :param edit_version: The edit_version of this LogAnalyticsField. @@ -323,7 +323,7 @@ def edit_version(self, edit_version): def facet_priority(self): """ Gets the facet_priority of this LogAnalyticsField. - facet priority + The facet priority. :return: The facet_priority of this LogAnalyticsField. @@ -335,7 +335,7 @@ def facet_priority(self): def facet_priority(self, facet_priority): """ Sets the facet_priority of this LogAnalyticsField. - facet priority + The facet priority. :param facet_priority: The facet_priority of this LogAnalyticsField. @@ -347,7 +347,7 @@ def facet_priority(self, facet_priority): def name(self): """ Gets the name of this LogAnalyticsField. - internal name + The field internal name. :return: The name of this LogAnalyticsField. @@ -359,7 +359,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsField. - internal name + The field internal name. :param name: The name of this LogAnalyticsField. @@ -371,7 +371,7 @@ def name(self, name): def is_facet_eligible(self): """ Gets the is_facet_eligible of this LogAnalyticsField. - is facet eligible flag + A flag inidcating whether or not the facet is elibigle for use. :return: The is_facet_eligible of this LogAnalyticsField. @@ -383,7 +383,7 @@ def is_facet_eligible(self): def is_facet_eligible(self, is_facet_eligible): """ Sets the is_facet_eligible of this LogAnalyticsField. - is facet eligible flag + A flag inidcating whether or not the facet is elibigle for use. :param is_facet_eligible: The is_facet_eligible of this LogAnalyticsField. @@ -395,7 +395,7 @@ def is_facet_eligible(self, is_facet_eligible): def is_high_cardinality(self): """ Gets the is_high_cardinality of this LogAnalyticsField. - is high cardinality flag + A flag inidcating whether or not the cardinality of the field is high. :return: The is_high_cardinality of this LogAnalyticsField. @@ -407,7 +407,7 @@ def is_high_cardinality(self): def is_high_cardinality(self, is_high_cardinality): """ Sets the is_high_cardinality of this LogAnalyticsField. - is high cardinality flag + A flag inidcating whether or not the cardinality of the field is high. :param is_high_cardinality: The is_high_cardinality of this LogAnalyticsField. @@ -419,7 +419,7 @@ def is_high_cardinality(self, is_high_cardinality): def is_large_data(self): """ Gets the is_large_data of this LogAnalyticsField. - is larget data flag + A flag inidcating whether or not the field is a large data field. :return: The is_large_data of this LogAnalyticsField. @@ -431,7 +431,7 @@ def is_large_data(self): def is_large_data(self, is_large_data): """ Sets the is_large_data of this LogAnalyticsField. - is larget data flag + A flag inidcating whether or not the field is a large data field. :param is_large_data: The is_large_data of this LogAnalyticsField. @@ -443,7 +443,7 @@ def is_large_data(self, is_large_data): def is_multi_valued(self): """ Gets the is_multi_valued of this LogAnalyticsField. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :return: The is_multi_valued of this LogAnalyticsField. @@ -455,7 +455,7 @@ def is_multi_valued(self): def is_multi_valued(self, is_multi_valued): """ Sets the is_multi_valued of this LogAnalyticsField. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :param is_multi_valued: The is_multi_valued of this LogAnalyticsField. @@ -467,7 +467,7 @@ def is_multi_valued(self, is_multi_valued): def is_primary(self): """ Gets the is_primary of this LogAnalyticsField. - is primary flag + A flag inidcating whether or not this is a primary field. :return: The is_primary of this LogAnalyticsField. @@ -479,7 +479,7 @@ def is_primary(self): def is_primary(self, is_primary): """ Sets the is_primary of this LogAnalyticsField. - is primary flag + A flag inidcating whether or not this is a primary field. :param is_primary: The is_primary of this LogAnalyticsField. @@ -491,7 +491,8 @@ def is_primary(self, is_primary): def is_system(self): """ Gets the is_system of this LogAnalyticsField. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsField. @@ -503,7 +504,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsField. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsField. @@ -515,7 +517,7 @@ def is_system(self, is_system): def is_summarizable(self): """ Gets the is_summarizable of this LogAnalyticsField. - is summarizable flag + A flag inidcating whether or not the field can be summarized. :return: The is_summarizable of this LogAnalyticsField. @@ -527,7 +529,7 @@ def is_summarizable(self): def is_summarizable(self, is_summarizable): """ Sets the is_summarizable of this LogAnalyticsField. - is summarizable flag + A flag inidcating whether or not the field can be summarized. :param is_summarizable: The is_summarizable of this LogAnalyticsField. @@ -539,7 +541,7 @@ def is_summarizable(self, is_summarizable): def mapped_value(self): """ Gets the mapped_value of this LogAnalyticsField. - mappable + The mapped value. :return: The mapped_value of this LogAnalyticsField. @@ -551,7 +553,7 @@ def mapped_value(self): def mapped_value(self, mapped_value): """ Sets the mapped_value of this LogAnalyticsField. - mappable + The mapped value. :param mapped_value: The mapped_value of this LogAnalyticsField. @@ -563,7 +565,7 @@ def mapped_value(self, mapped_value): def is_metric_key_eligible(self): """ Gets the is_metric_key_eligible of this LogAnalyticsField. - metric key eligible + A flag inidcating whether or not the field is metric key eligible. :return: The is_metric_key_eligible of this LogAnalyticsField. @@ -575,7 +577,7 @@ def is_metric_key_eligible(self): def is_metric_key_eligible(self, is_metric_key_eligible): """ Sets the is_metric_key_eligible of this LogAnalyticsField. - metric key eligible + A flag inidcating whether or not the field is metric key eligible. :param is_metric_key_eligible: The is_metric_key_eligible of this LogAnalyticsField. @@ -587,7 +589,7 @@ def is_metric_key_eligible(self, is_metric_key_eligible): def is_metric_value_eligible(self): """ Gets the is_metric_value_eligible of this LogAnalyticsField. - metric value eligible + A flag inidcating whether or not the field is metric value eligible. :return: The is_metric_value_eligible of this LogAnalyticsField. @@ -599,7 +601,7 @@ def is_metric_value_eligible(self): def is_metric_value_eligible(self, is_metric_value_eligible): """ Sets the is_metric_value_eligible of this LogAnalyticsField. - metric value eligible + A flag inidcating whether or not the field is metric value eligible. :param is_metric_value_eligible: The is_metric_value_eligible of this LogAnalyticsField. @@ -611,7 +613,7 @@ def is_metric_value_eligible(self, is_metric_value_eligible): def range_facet_eligible(self): """ Gets the range_facet_eligible of this LogAnalyticsField. - range facet eligible + A flag inidcating whether or not the field is range facet eligible. :return: The range_facet_eligible of this LogAnalyticsField. @@ -623,7 +625,7 @@ def range_facet_eligible(self): def range_facet_eligible(self, range_facet_eligible): """ Sets the range_facet_eligible of this LogAnalyticsField. - range facet eligible + A flag inidcating whether or not the field is range facet eligible. :param range_facet_eligible: The range_facet_eligible of this LogAnalyticsField. @@ -635,7 +637,7 @@ def range_facet_eligible(self, range_facet_eligible): def is_table_eligible(self): """ Gets the is_table_eligible of this LogAnalyticsField. - table eligible + A flag inidcating whether or not the field is table eligible. :return: The is_table_eligible of this LogAnalyticsField. @@ -647,7 +649,7 @@ def is_table_eligible(self): def is_table_eligible(self, is_table_eligible): """ Sets the is_table_eligible of this LogAnalyticsField. - table eligible + A flag inidcating whether or not the field is table eligible. :param is_table_eligible: The is_table_eligible of this LogAnalyticsField. @@ -659,7 +661,7 @@ def is_table_eligible(self, is_table_eligible): def unit_type(self): """ Gets the unit_type of this LogAnalyticsField. - unit type + The field unit type. :return: The unit_type of this LogAnalyticsField. @@ -671,7 +673,7 @@ def unit_type(self): def unit_type(self, unit_type): """ Sets the unit_type of this LogAnalyticsField. - unit type + The field unit type. :param unit_type: The unit_type of this LogAnalyticsField. diff --git a/src/oci/log_analytics/models/log_analytics_field_collection.py b/src/oci/log_analytics/models/log_analytics_field_collection.py index 3d9157850c..c7fda4a996 100644 --- a/src/oci/log_analytics/models/log_analytics_field_collection.py +++ b/src/oci/log_analytics/models/log_analytics_field_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsFieldCollection. - list of fields + An array of fields. :return: The items of this LogAnalyticsFieldCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsFieldCollection. - list of fields + An array of fields. :param items: The items of this LogAnalyticsFieldCollection. diff --git a/src/oci/log_analytics/models/log_analytics_field_summary.py b/src/oci/log_analytics/models/log_analytics_field_summary.py index 6b8d89db8b..af52e57cb6 100644 --- a/src/oci/log_analytics/models/log_analytics_field_summary.py +++ b/src/oci/log_analytics/models/log_analytics_field_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogAnalyticsFieldSummary(object): """ - summary of fields + A summary of a field. """ def __init__(self, **kwargs): @@ -203,7 +203,7 @@ def cee_alias(self, cee_alias): def data_type(self): """ Gets the data_type of this LogAnalyticsFieldSummary. - data type + The field data type. :return: The data_type of this LogAnalyticsFieldSummary. @@ -215,7 +215,7 @@ def data_type(self): def data_type(self, data_type): """ Sets the data_type of this LogAnalyticsFieldSummary. - data type + The field data type. :param data_type: The data_type of this LogAnalyticsFieldSummary. @@ -227,7 +227,7 @@ def data_type(self, data_type): def regular_expression(self): """ Gets the regular_expression of this LogAnalyticsFieldSummary. - default regular expression + The field default regular expression. :return: The regular_expression of this LogAnalyticsFieldSummary. @@ -239,7 +239,7 @@ def regular_expression(self): def regular_expression(self, regular_expression): """ Sets the regular_expression of this LogAnalyticsFieldSummary. - default regular expression + The field default regular expression. :param regular_expression: The regular_expression of this LogAnalyticsFieldSummary. @@ -251,7 +251,7 @@ def regular_expression(self, regular_expression): def description(self): """ Gets the description of this LogAnalyticsFieldSummary. - description + The field description. :return: The description of this LogAnalyticsFieldSummary. @@ -263,7 +263,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsFieldSummary. - description + The field description. :param description: The description of this LogAnalyticsFieldSummary. @@ -275,7 +275,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsFieldSummary. - display name + The field display name. :return: The display_name of this LogAnalyticsFieldSummary. @@ -287,7 +287,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsFieldSummary. - display name + The field display name. :param display_name: The display_name of this LogAnalyticsFieldSummary. @@ -299,7 +299,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsFieldSummary. - edit version + The field edit version. :return: The edit_version of this LogAnalyticsFieldSummary. @@ -311,7 +311,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsFieldSummary. - edit version + The field edit version. :param edit_version: The edit_version of this LogAnalyticsFieldSummary. @@ -323,7 +323,7 @@ def edit_version(self, edit_version): def facet_priority(self): """ Gets the facet_priority of this LogAnalyticsFieldSummary. - facet priority + The facet priority. :return: The facet_priority of this LogAnalyticsFieldSummary. @@ -335,7 +335,7 @@ def facet_priority(self): def facet_priority(self, facet_priority): """ Sets the facet_priority of this LogAnalyticsFieldSummary. - facet priority + The facet priority. :param facet_priority: The facet_priority of this LogAnalyticsFieldSummary. @@ -347,7 +347,7 @@ def facet_priority(self, facet_priority): def name(self): """ Gets the name of this LogAnalyticsFieldSummary. - internal name + The field internal name. :return: The name of this LogAnalyticsFieldSummary. @@ -359,7 +359,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsFieldSummary. - internal name + The field internal name. :param name: The name of this LogAnalyticsFieldSummary. @@ -371,7 +371,7 @@ def name(self, name): def is_facet_eligible(self): """ Gets the is_facet_eligible of this LogAnalyticsFieldSummary. - is facet eligible flag + A flag inidcating whether or not the facet is elibigle for use. :return: The is_facet_eligible of this LogAnalyticsFieldSummary. @@ -383,7 +383,7 @@ def is_facet_eligible(self): def is_facet_eligible(self, is_facet_eligible): """ Sets the is_facet_eligible of this LogAnalyticsFieldSummary. - is facet eligible flag + A flag inidcating whether or not the facet is elibigle for use. :param is_facet_eligible: The is_facet_eligible of this LogAnalyticsFieldSummary. @@ -395,7 +395,7 @@ def is_facet_eligible(self, is_facet_eligible): def is_high_cardinality(self): """ Gets the is_high_cardinality of this LogAnalyticsFieldSummary. - is high cardinality flag + A flag inidcating whether or not the cardinality of the field is high. :return: The is_high_cardinality of this LogAnalyticsFieldSummary. @@ -407,7 +407,7 @@ def is_high_cardinality(self): def is_high_cardinality(self, is_high_cardinality): """ Sets the is_high_cardinality of this LogAnalyticsFieldSummary. - is high cardinality flag + A flag inidcating whether or not the cardinality of the field is high. :param is_high_cardinality: The is_high_cardinality of this LogAnalyticsFieldSummary. @@ -419,7 +419,7 @@ def is_high_cardinality(self, is_high_cardinality): def is_large_data(self): """ Gets the is_large_data of this LogAnalyticsFieldSummary. - is larget data flag + A flag inidcating whether or not the field is a large data field. :return: The is_large_data of this LogAnalyticsFieldSummary. @@ -431,7 +431,7 @@ def is_large_data(self): def is_large_data(self, is_large_data): """ Sets the is_large_data of this LogAnalyticsFieldSummary. - is larget data flag + A flag inidcating whether or not the field is a large data field. :param is_large_data: The is_large_data of this LogAnalyticsFieldSummary. @@ -443,7 +443,7 @@ def is_large_data(self, is_large_data): def is_multi_valued(self): """ Gets the is_multi_valued of this LogAnalyticsFieldSummary. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :return: The is_multi_valued of this LogAnalyticsFieldSummary. @@ -455,7 +455,7 @@ def is_multi_valued(self): def is_multi_valued(self, is_multi_valued): """ Sets the is_multi_valued of this LogAnalyticsFieldSummary. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :param is_multi_valued: The is_multi_valued of this LogAnalyticsFieldSummary. @@ -467,7 +467,7 @@ def is_multi_valued(self, is_multi_valued): def is_primary(self): """ Gets the is_primary of this LogAnalyticsFieldSummary. - is primary flag + A flag inidcating whether or not this is a primary field. :return: The is_primary of this LogAnalyticsFieldSummary. @@ -479,7 +479,7 @@ def is_primary(self): def is_primary(self, is_primary): """ Sets the is_primary of this LogAnalyticsFieldSummary. - is primary flag + A flag inidcating whether or not this is a primary field. :param is_primary: The is_primary of this LogAnalyticsFieldSummary. @@ -491,7 +491,8 @@ def is_primary(self, is_primary): def is_system(self): """ Gets the is_system of this LogAnalyticsFieldSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsFieldSummary. @@ -503,7 +504,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsFieldSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsFieldSummary. @@ -515,7 +517,7 @@ def is_system(self, is_system): def is_summarizable(self): """ Gets the is_summarizable of this LogAnalyticsFieldSummary. - is summarizable flag + A flag inidcating whether or not the field can be summarized. :return: The is_summarizable of this LogAnalyticsFieldSummary. @@ -527,7 +529,7 @@ def is_summarizable(self): def is_summarizable(self, is_summarizable): """ Sets the is_summarizable of this LogAnalyticsFieldSummary. - is summarizable flag + A flag inidcating whether or not the field can be summarized. :param is_summarizable: The is_summarizable of this LogAnalyticsFieldSummary. @@ -539,7 +541,7 @@ def is_summarizable(self, is_summarizable): def mapped_value(self): """ Gets the mapped_value of this LogAnalyticsFieldSummary. - mappable + The mapped value. :return: The mapped_value of this LogAnalyticsFieldSummary. @@ -551,7 +553,7 @@ def mapped_value(self): def mapped_value(self, mapped_value): """ Sets the mapped_value of this LogAnalyticsFieldSummary. - mappable + The mapped value. :param mapped_value: The mapped_value of this LogAnalyticsFieldSummary. @@ -563,7 +565,7 @@ def mapped_value(self, mapped_value): def is_metric_key_eligible(self): """ Gets the is_metric_key_eligible of this LogAnalyticsFieldSummary. - metric key eligible + A flag inidcating whether or not the field is metric key eligible. :return: The is_metric_key_eligible of this LogAnalyticsFieldSummary. @@ -575,7 +577,7 @@ def is_metric_key_eligible(self): def is_metric_key_eligible(self, is_metric_key_eligible): """ Sets the is_metric_key_eligible of this LogAnalyticsFieldSummary. - metric key eligible + A flag inidcating whether or not the field is metric key eligible. :param is_metric_key_eligible: The is_metric_key_eligible of this LogAnalyticsFieldSummary. @@ -587,7 +589,7 @@ def is_metric_key_eligible(self, is_metric_key_eligible): def is_metric_value_eligible(self): """ Gets the is_metric_value_eligible of this LogAnalyticsFieldSummary. - metric value eligible + A flag inidcating whether or not the field is metric value eligible. :return: The is_metric_value_eligible of this LogAnalyticsFieldSummary. @@ -599,7 +601,7 @@ def is_metric_value_eligible(self): def is_metric_value_eligible(self, is_metric_value_eligible): """ Sets the is_metric_value_eligible of this LogAnalyticsFieldSummary. - metric value eligible + A flag inidcating whether or not the field is metric value eligible. :param is_metric_value_eligible: The is_metric_value_eligible of this LogAnalyticsFieldSummary. @@ -611,7 +613,7 @@ def is_metric_value_eligible(self, is_metric_value_eligible): def range_facet_eligible(self): """ Gets the range_facet_eligible of this LogAnalyticsFieldSummary. - range facet eligible + A flag inidcating whether or not the field is range facet eligible. :return: The range_facet_eligible of this LogAnalyticsFieldSummary. @@ -623,7 +625,7 @@ def range_facet_eligible(self): def range_facet_eligible(self, range_facet_eligible): """ Sets the range_facet_eligible of this LogAnalyticsFieldSummary. - range facet eligible + A flag inidcating whether or not the field is range facet eligible. :param range_facet_eligible: The range_facet_eligible of this LogAnalyticsFieldSummary. @@ -635,7 +637,7 @@ def range_facet_eligible(self, range_facet_eligible): def is_table_eligible(self): """ Gets the is_table_eligible of this LogAnalyticsFieldSummary. - table eligible + A flag inidcating whether or not the field is table eligible. :return: The is_table_eligible of this LogAnalyticsFieldSummary. @@ -647,7 +649,7 @@ def is_table_eligible(self): def is_table_eligible(self, is_table_eligible): """ Sets the is_table_eligible of this LogAnalyticsFieldSummary. - table eligible + A flag inidcating whether or not the field is table eligible. :param is_table_eligible: The is_table_eligible of this LogAnalyticsFieldSummary. @@ -659,7 +661,7 @@ def is_table_eligible(self, is_table_eligible): def unit_type(self): """ Gets the unit_type of this LogAnalyticsFieldSummary. - unit type + The field unit type. :return: The unit_type of this LogAnalyticsFieldSummary. @@ -671,7 +673,7 @@ def unit_type(self): def unit_type(self, unit_type): """ Sets the unit_type of this LogAnalyticsFieldSummary. - unit type + The field unit type. :param unit_type: The unit_type of this LogAnalyticsFieldSummary. diff --git a/src/oci/log_analytics/models/log_analytics_import_custom_change_list.py b/src/oci/log_analytics/models/log_analytics_import_custom_change_list.py index 2b6effbbc1..0382918998 100644 --- a/src/oci/log_analytics/models/log_analytics_import_custom_change_list.py +++ b/src/oci/log_analytics/models/log_analytics_import_custom_change_list.py @@ -93,7 +93,7 @@ def __init__(self, **kwargs): def created_parser_names(self): """ Gets the created_parser_names of this LogAnalyticsImportCustomChangeList. - createdParserNames + An array of created parser names. :return: The created_parser_names of this LogAnalyticsImportCustomChangeList. @@ -105,7 +105,7 @@ def created_parser_names(self): def created_parser_names(self, created_parser_names): """ Sets the created_parser_names of this LogAnalyticsImportCustomChangeList. - createdParserNames + An array of created parser names. :param created_parser_names: The created_parser_names of this LogAnalyticsImportCustomChangeList. @@ -117,7 +117,7 @@ def created_parser_names(self, created_parser_names): def updated_parser_names(self): """ Gets the updated_parser_names of this LogAnalyticsImportCustomChangeList. - updatedParserNames + An array of updated parser names. :return: The updated_parser_names of this LogAnalyticsImportCustomChangeList. @@ -129,7 +129,7 @@ def updated_parser_names(self): def updated_parser_names(self, updated_parser_names): """ Sets the updated_parser_names of this LogAnalyticsImportCustomChangeList. - updatedParserNames + An array of updated parser names. :param updated_parser_names: The updated_parser_names of this LogAnalyticsImportCustomChangeList. @@ -141,7 +141,7 @@ def updated_parser_names(self, updated_parser_names): def created_source_names(self): """ Gets the created_source_names of this LogAnalyticsImportCustomChangeList. - createdSourceNames + An array of created source names. :return: The created_source_names of this LogAnalyticsImportCustomChangeList. @@ -153,7 +153,7 @@ def created_source_names(self): def created_source_names(self, created_source_names): """ Sets the created_source_names of this LogAnalyticsImportCustomChangeList. - createdSourceNames + An array of created source names. :param created_source_names: The created_source_names of this LogAnalyticsImportCustomChangeList. @@ -165,7 +165,7 @@ def created_source_names(self, created_source_names): def updated_source_names(self): """ Gets the updated_source_names of this LogAnalyticsImportCustomChangeList. - updatedSourceNames + An array of updated source names. :return: The updated_source_names of this LogAnalyticsImportCustomChangeList. @@ -177,7 +177,7 @@ def updated_source_names(self): def updated_source_names(self, updated_source_names): """ Sets the updated_source_names of this LogAnalyticsImportCustomChangeList. - updatedSourceNames + An array of updated source names. :param updated_source_names: The updated_source_names of this LogAnalyticsImportCustomChangeList. @@ -189,7 +189,7 @@ def updated_source_names(self, updated_source_names): def created_field_display_names(self): """ Gets the created_field_display_names of this LogAnalyticsImportCustomChangeList. - createdFieldDisplayNames + An array of created field display names. :return: The created_field_display_names of this LogAnalyticsImportCustomChangeList. @@ -201,7 +201,7 @@ def created_field_display_names(self): def created_field_display_names(self, created_field_display_names): """ Sets the created_field_display_names of this LogAnalyticsImportCustomChangeList. - createdFieldDisplayNames + An array of created field display names. :param created_field_display_names: The created_field_display_names of this LogAnalyticsImportCustomChangeList. @@ -213,7 +213,7 @@ def created_field_display_names(self, created_field_display_names): def updated_field_display_names(self): """ Gets the updated_field_display_names of this LogAnalyticsImportCustomChangeList. - updatedFieldDisplayNames + An array of updated field display names. :return: The updated_field_display_names of this LogAnalyticsImportCustomChangeList. @@ -225,7 +225,7 @@ def updated_field_display_names(self): def updated_field_display_names(self, updated_field_display_names): """ Sets the updated_field_display_names of this LogAnalyticsImportCustomChangeList. - updatedFieldDisplayNames + An array of updated field display names. :param updated_field_display_names: The updated_field_display_names of this LogAnalyticsImportCustomChangeList. @@ -237,7 +237,7 @@ def updated_field_display_names(self, updated_field_display_names): def conflict_parser_names(self): """ Gets the conflict_parser_names of this LogAnalyticsImportCustomChangeList. - conflictParserNames + A list of parser names with conflicts. :return: The conflict_parser_names of this LogAnalyticsImportCustomChangeList. @@ -249,7 +249,7 @@ def conflict_parser_names(self): def conflict_parser_names(self, conflict_parser_names): """ Sets the conflict_parser_names of this LogAnalyticsImportCustomChangeList. - conflictParserNames + A list of parser names with conflicts. :param conflict_parser_names: The conflict_parser_names of this LogAnalyticsImportCustomChangeList. @@ -261,7 +261,7 @@ def conflict_parser_names(self, conflict_parser_names): def conflict_source_names(self): """ Gets the conflict_source_names of this LogAnalyticsImportCustomChangeList. - conflictSourceNames + A list of source names with conflicts. :return: The conflict_source_names of this LogAnalyticsImportCustomChangeList. @@ -273,7 +273,7 @@ def conflict_source_names(self): def conflict_source_names(self, conflict_source_names): """ Sets the conflict_source_names of this LogAnalyticsImportCustomChangeList. - conflictSourceNames + A list of source names with conflicts. :param conflict_source_names: The conflict_source_names of this LogAnalyticsImportCustomChangeList. @@ -285,7 +285,7 @@ def conflict_source_names(self, conflict_source_names): def conflict_field_display_names(self): """ Gets the conflict_field_display_names of this LogAnalyticsImportCustomChangeList. - conflictFieldDisplayNames + A list of field display names with conflicts. :return: The conflict_field_display_names of this LogAnalyticsImportCustomChangeList. @@ -297,7 +297,7 @@ def conflict_field_display_names(self): def conflict_field_display_names(self, conflict_field_display_names): """ Sets the conflict_field_display_names of this LogAnalyticsImportCustomChangeList. - conflictFieldDisplayNames + A list of field display names with conflicts. :param conflict_field_display_names: The conflict_field_display_names of this LogAnalyticsImportCustomChangeList. diff --git a/src/oci/log_analytics/models/log_analytics_import_custom_content.py b/src/oci/log_analytics/models/log_analytics_import_custom_content.py index c6052e0b16..79c7078bca 100644 --- a/src/oci/log_analytics/models/log_analytics_import_custom_content.py +++ b/src/oci/log_analytics/models/log_analytics_import_custom_content.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def parser_names(self): """ Gets the parser_names of this LogAnalyticsImportCustomContent. - parserNames + The parser names. :return: The parser_names of this LogAnalyticsImportCustomContent. @@ -77,7 +77,7 @@ def parser_names(self): def parser_names(self, parser_names): """ Sets the parser_names of this LogAnalyticsImportCustomContent. - parserNames + The parser names. :param parser_names: The parser_names of this LogAnalyticsImportCustomContent. @@ -89,7 +89,7 @@ def parser_names(self, parser_names): def source_names(self): """ Gets the source_names of this LogAnalyticsImportCustomContent. - sourceNames + The source names. :return: The source_names of this LogAnalyticsImportCustomContent. @@ -101,7 +101,7 @@ def source_names(self): def source_names(self, source_names): """ Sets the source_names of this LogAnalyticsImportCustomContent. - sourceNames + The source names. :param source_names: The source_names of this LogAnalyticsImportCustomContent. @@ -113,7 +113,7 @@ def source_names(self, source_names): def field_names(self): """ Gets the field_names of this LogAnalyticsImportCustomContent. - fieldNames + The field names. :return: The field_names of this LogAnalyticsImportCustomContent. @@ -125,7 +125,7 @@ def field_names(self): def field_names(self, field_names): """ Sets the field_names of this LogAnalyticsImportCustomContent. - fieldNames + The field names. :param field_names: The field_names of this LogAnalyticsImportCustomContent. @@ -157,7 +157,7 @@ def change_list(self, change_list): def content_name(self): """ Gets the content_name of this LogAnalyticsImportCustomContent. - contentName + The content name. :return: The content_name of this LogAnalyticsImportCustomContent. @@ -169,7 +169,7 @@ def content_name(self): def content_name(self, content_name): """ Sets the content_name of this LogAnalyticsImportCustomContent. - contentName + The content name. :param content_name: The content_name of this LogAnalyticsImportCustomContent. diff --git a/src/oci/log_analytics/models/log_analytics_label.py b/src/oci/log_analytics/models/log_analytics_label.py index cfa93b42fd..603dc80105 100644 --- a/src/oci/log_analytics/models/log_analytics_label.py +++ b/src/oci/log_analytics/models/log_analytics_label.py @@ -149,7 +149,7 @@ def __init__(self, **kwargs): def aliases(self): """ Gets the aliases of this LogAnalyticsLabel. - alias list + An array of label aliases. :return: The aliases of this LogAnalyticsLabel. @@ -161,7 +161,7 @@ def aliases(self): def aliases(self, aliases): """ Sets the aliases of this LogAnalyticsLabel. - alias list + An array of label aliases. :param aliases: The aliases of this LogAnalyticsLabel. @@ -173,7 +173,7 @@ def aliases(self, aliases): def count_usage_in_source(self): """ Gets the count_usage_in_source of this LogAnalyticsLabel. - count usage in source + The source usage count for this label. :return: The count_usage_in_source of this LogAnalyticsLabel. @@ -185,7 +185,7 @@ def count_usage_in_source(self): def count_usage_in_source(self, count_usage_in_source): """ Sets the count_usage_in_source of this LogAnalyticsLabel. - count usage in source + The source usage count for this label. :param count_usage_in_source: The count_usage_in_source of this LogAnalyticsLabel. @@ -197,7 +197,7 @@ def count_usage_in_source(self, count_usage_in_source): def suggest_type(self): """ Gets the suggest_type of this LogAnalyticsLabel. - suggest type + The type of suggestion for label usage. :return: The suggest_type of this LogAnalyticsLabel. @@ -209,7 +209,7 @@ def suggest_type(self): def suggest_type(self, suggest_type): """ Sets the suggest_type of this LogAnalyticsLabel. - suggest type + The type of suggestion for label usage. :param suggest_type: The suggest_type of this LogAnalyticsLabel. @@ -221,7 +221,7 @@ def suggest_type(self, suggest_type): def description(self): """ Gets the description of this LogAnalyticsLabel. - description + The label description. :return: The description of this LogAnalyticsLabel. @@ -233,7 +233,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsLabel. - description + The label description. :param description: The description of this LogAnalyticsLabel. @@ -245,7 +245,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsLabel. - display name + The label display name. :return: The display_name of this LogAnalyticsLabel. @@ -257,7 +257,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsLabel. - display name + The label display name. :param display_name: The display_name of this LogAnalyticsLabel. @@ -269,7 +269,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsLabel. - edit version + The label edit version. :return: The edit_version of this LogAnalyticsLabel. @@ -281,7 +281,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsLabel. - edit version + The label edit version. :param edit_version: The edit_version of this LogAnalyticsLabel. @@ -293,7 +293,7 @@ def edit_version(self, edit_version): def impact(self): """ Gets the impact of this LogAnalyticsLabel. - impact + The label impact. :return: The impact of this LogAnalyticsLabel. @@ -305,7 +305,7 @@ def impact(self): def impact(self, impact): """ Sets the impact of this LogAnalyticsLabel. - impact + The label impact. :param impact: The impact of this LogAnalyticsLabel. @@ -317,7 +317,8 @@ def impact(self, impact): def is_system(self): """ Gets the is_system of this LogAnalyticsLabel. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :return: The is_system of this LogAnalyticsLabel. @@ -329,7 +330,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsLabel. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :param is_system: The is_system of this LogAnalyticsLabel. @@ -341,7 +343,7 @@ def is_system(self, is_system): def name(self): """ Gets the name of this LogAnalyticsLabel. - label identifier + The label name. :return: The name of this LogAnalyticsLabel. @@ -353,7 +355,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLabel. - label identifier + The label name. :param name: The name of this LogAnalyticsLabel. @@ -365,7 +367,7 @@ def name(self, name): def priority(self): """ Gets the priority of this LogAnalyticsLabel. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -380,7 +382,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this LogAnalyticsLabel. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. :param priority: The priority of this LogAnalyticsLabel. @@ -395,7 +397,7 @@ def priority(self, priority): def recommendation(self): """ Gets the recommendation of this LogAnalyticsLabel. - tag recommendation + The label recommendation. :return: The recommendation of this LogAnalyticsLabel. @@ -407,7 +409,7 @@ def recommendation(self): def recommendation(self, recommendation): """ Sets the recommendation of this LogAnalyticsLabel. - tag recommendation + The label recommendation. :param recommendation: The recommendation of this LogAnalyticsLabel. @@ -419,7 +421,7 @@ def recommendation(self, recommendation): def type(self): """ Gets the type of this LogAnalyticsLabel. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. Allowed values for this property are: "INFO", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -434,7 +436,7 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsLabel. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. :param type: The type of this LogAnalyticsLabel. @@ -449,7 +451,7 @@ def type(self, type): def is_user_deleted(self): """ Gets the is_user_deleted of this LogAnalyticsLabel. - user deleted flag + A flag indicating whether or not the label has been deleted. :return: The is_user_deleted of this LogAnalyticsLabel. @@ -461,7 +463,7 @@ def is_user_deleted(self): def is_user_deleted(self, is_user_deleted): """ Sets the is_user_deleted of this LogAnalyticsLabel. - user deleted flag + A flag indicating whether or not the label has been deleted. :param is_user_deleted: The is_user_deleted of this LogAnalyticsLabel. diff --git a/src/oci/log_analytics/models/log_analytics_label_alias.py b/src/oci/log_analytics/models/log_analytics_label_alias.py index 374f90b80d..c12b112378 100644 --- a/src/oci/log_analytics/models/log_analytics_label_alias.py +++ b/src/oci/log_analytics/models/log_analytics_label_alias.py @@ -90,7 +90,7 @@ def __init__(self, **kwargs): def alias(self): """ Gets the alias of this LogAnalyticsLabelAlias. - alias + The alias. :return: The alias of this LogAnalyticsLabelAlias. @@ -102,7 +102,7 @@ def alias(self): def alias(self, alias): """ Sets the alias of this LogAnalyticsLabelAlias. - alias + The alias. :param alias: The alias of this LogAnalyticsLabelAlias. @@ -114,7 +114,7 @@ def alias(self, alias): def alias_display_name(self): """ Gets the alias_display_name of this LogAnalyticsLabelAlias. - alias display name + The alias display name. :return: The alias_display_name of this LogAnalyticsLabelAlias. @@ -126,7 +126,7 @@ def alias_display_name(self): def alias_display_name(self, alias_display_name): """ Sets the alias_display_name of this LogAnalyticsLabelAlias. - alias display name + The alias display name. :param alias_display_name: The alias_display_name of this LogAnalyticsLabelAlias. @@ -138,7 +138,8 @@ def alias_display_name(self, alias_display_name): def is_system(self): """ Gets the is_system of this LogAnalyticsLabelAlias. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsLabelAlias. @@ -150,7 +151,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsLabelAlias. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsLabelAlias. @@ -162,7 +164,7 @@ def is_system(self, is_system): def display_name(self): """ Gets the display_name of this LogAnalyticsLabelAlias. - label display name + The label display name. :return: The display_name of this LogAnalyticsLabelAlias. @@ -174,7 +176,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsLabelAlias. - label display name + The label display name. :param display_name: The display_name of this LogAnalyticsLabelAlias. @@ -186,7 +188,7 @@ def display_name(self, display_name): def name(self): """ Gets the name of this LogAnalyticsLabelAlias. - label name + The label name. :return: The name of this LogAnalyticsLabelAlias. @@ -198,7 +200,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLabelAlias. - label name + The label name. :param name: The name of this LogAnalyticsLabelAlias. @@ -210,7 +212,7 @@ def name(self, name): def priority(self): """ Gets the priority of this LogAnalyticsLabelAlias. - priority + The label priority. Default value is NONE. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -225,7 +227,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this LogAnalyticsLabelAlias. - priority + The label priority. Default value is NONE. :param priority: The priority of this LogAnalyticsLabelAlias. diff --git a/src/oci/log_analytics/models/log_analytics_label_collection.py b/src/oci/log_analytics/models/log_analytics_label_collection.py index 65c29e86a4..e3e4bfb326 100644 --- a/src/oci/log_analytics/models/log_analytics_label_collection.py +++ b/src/oci/log_analytics/models/log_analytics_label_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogAnalyticsLabelCollection(object): """ - LogAnalytics Label Collection + A collection of LogAnalytics Labels. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsLabelCollection. - Array of log analytics label summary. + An array of log analytics label summaries. :return: The items of this LogAnalyticsLabelCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsLabelCollection. - Array of log analytics label summary. + An array of log analytics label summaries. :param items: The items of this LogAnalyticsLabelCollection. diff --git a/src/oci/log_analytics/models/log_analytics_label_definition.py b/src/oci/log_analytics/models/log_analytics_label_definition.py index 07279103da..94078d9f64 100644 --- a/src/oci/log_analytics/models/log_analytics_label_definition.py +++ b/src/oci/log_analytics/models/log_analytics_label_definition.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def edit_version(self): """ Gets the edit_version of this LogAnalyticsLabelDefinition. - edit version + The edit version. :return: The edit_version of this LogAnalyticsLabelDefinition. @@ -70,7 +70,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsLabelDefinition. - edit version + The edit version. :param edit_version: The edit_version of this LogAnalyticsLabelDefinition. @@ -82,7 +82,8 @@ def edit_version(self, edit_version): def is_system(self): """ Gets the is_system of this LogAnalyticsLabelDefinition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsLabelDefinition. @@ -94,7 +95,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsLabelDefinition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsLabelDefinition. @@ -106,7 +108,7 @@ def is_system(self, is_system): def source_id(self): """ Gets the source_id of this LogAnalyticsLabelDefinition. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsLabelDefinition. @@ -118,7 +120,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsLabelDefinition. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsLabelDefinition. @@ -130,7 +132,7 @@ def source_id(self, source_id): def label_name(self): """ Gets the label_name of this LogAnalyticsLabelDefinition. - label name + The label name. :return: The label_name of this LogAnalyticsLabelDefinition. @@ -142,7 +144,7 @@ def label_name(self): def label_name(self, label_name): """ Sets the label_name of this LogAnalyticsLabelDefinition. - label name + The label name. :param label_name: The label_name of this LogAnalyticsLabelDefinition. diff --git a/src/oci/log_analytics/models/log_analytics_label_operator.py b/src/oci/log_analytics/models/log_analytics_label_operator.py index e09f620e22..f6c3185a4c 100644 --- a/src/oci/log_analytics/models/log_analytics_label_operator.py +++ b/src/oci/log_analytics/models/log_analytics_label_operator.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this LogAnalyticsLabelOperator. - operator display name + The operator display name. :return: The display_name of this LogAnalyticsLabelOperator. @@ -56,7 +56,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsLabelOperator. - operator display name + The operator display name. :param display_name: The display_name of this LogAnalyticsLabelOperator. @@ -68,7 +68,7 @@ def display_name(self, display_name): def name(self): """ Gets the name of this LogAnalyticsLabelOperator. - operator internal name + The operator internal name. :return: The name of this LogAnalyticsLabelOperator. @@ -80,7 +80,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLabelOperator. - operator internal name + The operator internal name. :param name: The name of this LogAnalyticsLabelOperator. diff --git a/src/oci/log_analytics/models/log_analytics_label_operator_collection.py b/src/oci/log_analytics/models/log_analytics_label_operator_collection.py index f5ca6303a7..8176e5c1d3 100644 --- a/src/oci/log_analytics/models/log_analytics_label_operator_collection.py +++ b/src/oci/log_analytics/models/log_analytics_label_operator_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsLabelOperatorCollection. - list of label operators + An array of of label operators. :return: The items of this LogAnalyticsLabelOperatorCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsLabelOperatorCollection. - list of label operators + An array of of label operators. :param items: The items of this LogAnalyticsLabelOperatorCollection. diff --git a/src/oci/log_analytics/models/log_analytics_label_summary.py b/src/oci/log_analytics/models/log_analytics_label_summary.py index 4e6c75fc29..cb56c29a72 100644 --- a/src/oci/log_analytics/models/log_analytics_label_summary.py +++ b/src/oci/log_analytics/models/log_analytics_label_summary.py @@ -149,7 +149,7 @@ def __init__(self, **kwargs): def aliases(self): """ Gets the aliases of this LogAnalyticsLabelSummary. - alias list + The alias list. :return: The aliases of this LogAnalyticsLabelSummary. @@ -161,7 +161,7 @@ def aliases(self): def aliases(self, aliases): """ Sets the aliases of this LogAnalyticsLabelSummary. - alias list + The alias list. :param aliases: The aliases of this LogAnalyticsLabelSummary. @@ -173,7 +173,7 @@ def aliases(self, aliases): def count_usage_in_source(self): """ Gets the count_usage_in_source of this LogAnalyticsLabelSummary. - count usage in source + The source usage count for this label. :return: The count_usage_in_source of this LogAnalyticsLabelSummary. @@ -185,7 +185,7 @@ def count_usage_in_source(self): def count_usage_in_source(self, count_usage_in_source): """ Sets the count_usage_in_source of this LogAnalyticsLabelSummary. - count usage in source + The source usage count for this label. :param count_usage_in_source: The count_usage_in_source of this LogAnalyticsLabelSummary. @@ -197,7 +197,7 @@ def count_usage_in_source(self, count_usage_in_source): def suggest_type(self): """ Gets the suggest_type of this LogAnalyticsLabelSummary. - suggest type + The type of suggestion for label usage. :return: The suggest_type of this LogAnalyticsLabelSummary. @@ -209,7 +209,7 @@ def suggest_type(self): def suggest_type(self, suggest_type): """ Sets the suggest_type of this LogAnalyticsLabelSummary. - suggest type + The type of suggestion for label usage. :param suggest_type: The suggest_type of this LogAnalyticsLabelSummary. @@ -221,7 +221,7 @@ def suggest_type(self, suggest_type): def description(self): """ Gets the description of this LogAnalyticsLabelSummary. - description + The label description. :return: The description of this LogAnalyticsLabelSummary. @@ -233,7 +233,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsLabelSummary. - description + The label description. :param description: The description of this LogAnalyticsLabelSummary. @@ -245,7 +245,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsLabelSummary. - display name + The label display name. :return: The display_name of this LogAnalyticsLabelSummary. @@ -257,7 +257,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsLabelSummary. - display name + The label display name. :param display_name: The display_name of this LogAnalyticsLabelSummary. @@ -269,7 +269,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsLabelSummary. - edit version + The label edit version. :return: The edit_version of this LogAnalyticsLabelSummary. @@ -281,7 +281,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsLabelSummary. - edit version + The label edit version. :param edit_version: The edit_version of this LogAnalyticsLabelSummary. @@ -293,7 +293,7 @@ def edit_version(self, edit_version): def impact(self): """ Gets the impact of this LogAnalyticsLabelSummary. - impact + The label impact. :return: The impact of this LogAnalyticsLabelSummary. @@ -305,7 +305,7 @@ def impact(self): def impact(self, impact): """ Sets the impact of this LogAnalyticsLabelSummary. - impact + The label impact. :param impact: The impact of this LogAnalyticsLabelSummary. @@ -317,7 +317,8 @@ def impact(self, impact): def is_system(self): """ Gets the is_system of this LogAnalyticsLabelSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :return: The is_system of this LogAnalyticsLabelSummary. @@ -329,7 +330,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsLabelSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :param is_system: The is_system of this LogAnalyticsLabelSummary. @@ -341,7 +343,7 @@ def is_system(self, is_system): def name(self): """ Gets the name of this LogAnalyticsLabelSummary. - label identifier + The label name. :return: The name of this LogAnalyticsLabelSummary. @@ -353,7 +355,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLabelSummary. - label identifier + The label name. :param name: The name of this LogAnalyticsLabelSummary. @@ -365,7 +367,7 @@ def name(self, name): def priority(self): """ Gets the priority of this LogAnalyticsLabelSummary. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -380,7 +382,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this LogAnalyticsLabelSummary. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. :param priority: The priority of this LogAnalyticsLabelSummary. @@ -395,7 +397,7 @@ def priority(self, priority): def recommendation(self): """ Gets the recommendation of this LogAnalyticsLabelSummary. - tag recommendation + The label recommendation. :return: The recommendation of this LogAnalyticsLabelSummary. @@ -407,7 +409,7 @@ def recommendation(self): def recommendation(self, recommendation): """ Sets the recommendation of this LogAnalyticsLabelSummary. - tag recommendation + The label recommendation. :param recommendation: The recommendation of this LogAnalyticsLabelSummary. @@ -419,7 +421,7 @@ def recommendation(self, recommendation): def type(self): """ Gets the type of this LogAnalyticsLabelSummary. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. Allowed values for this property are: "INFO", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -434,7 +436,7 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsLabelSummary. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. :param type: The type of this LogAnalyticsLabelSummary. @@ -449,7 +451,7 @@ def type(self, type): def is_user_deleted(self): """ Gets the is_user_deleted of this LogAnalyticsLabelSummary. - user deleted flag + A flag indicating whether or not the label has been deleted. :return: The is_user_deleted of this LogAnalyticsLabelSummary. @@ -461,7 +463,7 @@ def is_user_deleted(self): def is_user_deleted(self, is_user_deleted): """ Sets the is_user_deleted of this LogAnalyticsLabelSummary. - user deleted flag + A flag indicating whether or not the label has been deleted. :param is_user_deleted: The is_user_deleted of this LogAnalyticsLabelSummary. diff --git a/src/oci/log_analytics/models/log_analytics_label_view.py b/src/oci/log_analytics/models/log_analytics_label_view.py index 4fed61225c..83c08f644b 100644 --- a/src/oci/log_analytics/models/log_analytics_label_view.py +++ b/src/oci/log_analytics/models/log_analytics_label_view.py @@ -153,7 +153,7 @@ def __init__(self, **kwargs): def aliases(self): """ Gets the aliases of this LogAnalyticsLabelView. - alias list + An arrya of label aliases. :return: The aliases of this LogAnalyticsLabelView. @@ -165,7 +165,7 @@ def aliases(self): def aliases(self, aliases): """ Sets the aliases of this LogAnalyticsLabelView. - alias list + An arrya of label aliases. :param aliases: The aliases of this LogAnalyticsLabelView. @@ -177,7 +177,7 @@ def aliases(self, aliases): def count_usage_in_alert_rule(self): """ Gets the count_usage_in_alert_rule of this LogAnalyticsLabelView. - alert rule usage count + The label alert rule usage count. :return: The count_usage_in_alert_rule of this LogAnalyticsLabelView. @@ -189,7 +189,7 @@ def count_usage_in_alert_rule(self): def count_usage_in_alert_rule(self, count_usage_in_alert_rule): """ Sets the count_usage_in_alert_rule of this LogAnalyticsLabelView. - alert rule usage count + The label alert rule usage count. :param count_usage_in_alert_rule: The count_usage_in_alert_rule of this LogAnalyticsLabelView. @@ -201,7 +201,7 @@ def count_usage_in_alert_rule(self, count_usage_in_alert_rule): def count_usage_in_source(self): """ Gets the count_usage_in_source of this LogAnalyticsLabelView. - source usage count + The label source usage count. :return: The count_usage_in_source of this LogAnalyticsLabelView. @@ -213,7 +213,7 @@ def count_usage_in_source(self): def count_usage_in_source(self, count_usage_in_source): """ Sets the count_usage_in_source of this LogAnalyticsLabelView. - source usage count + The label source usage count. :param count_usage_in_source: The count_usage_in_source of this LogAnalyticsLabelView. @@ -225,7 +225,7 @@ def count_usage_in_source(self, count_usage_in_source): def id(self): """ Gets the id of this LogAnalyticsLabelView. - id + The label unique identifier. :return: The id of this LogAnalyticsLabelView. @@ -237,7 +237,7 @@ def id(self): def id(self, id): """ Sets the id of this LogAnalyticsLabelView. - id + The label unique identifier. :param id: The id of this LogAnalyticsLabelView. @@ -249,7 +249,7 @@ def id(self, id): def suggest_type(self): """ Gets the suggest_type of this LogAnalyticsLabelView. - suggest type + The label suggestion type. :return: The suggest_type of this LogAnalyticsLabelView. @@ -261,7 +261,7 @@ def suggest_type(self): def suggest_type(self, suggest_type): """ Sets the suggest_type of this LogAnalyticsLabelView. - suggest type + The label suggestion type. :param suggest_type: The suggest_type of this LogAnalyticsLabelView. @@ -273,7 +273,7 @@ def suggest_type(self, suggest_type): def description(self): """ Gets the description of this LogAnalyticsLabelView. - label description + The label description. :return: The description of this LogAnalyticsLabelView. @@ -285,7 +285,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsLabelView. - label description + The label description. :param description: The description of this LogAnalyticsLabelView. @@ -297,7 +297,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsLabelView. - label display name + The label display name. :return: The display_name of this LogAnalyticsLabelView. @@ -309,7 +309,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsLabelView. - label display name + The label display name. :param display_name: The display_name of this LogAnalyticsLabelView. @@ -321,7 +321,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsLabelView. - tag edit version + The label edit version. :return: The edit_version of this LogAnalyticsLabelView. @@ -333,7 +333,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsLabelView. - tag edit version + The label edit version. :param edit_version: The edit_version of this LogAnalyticsLabelView. @@ -345,7 +345,7 @@ def edit_version(self, edit_version): def impact(self): """ Gets the impact of this LogAnalyticsLabelView. - label impact + The label impact. :return: The impact of this LogAnalyticsLabelView. @@ -357,7 +357,7 @@ def impact(self): def impact(self, impact): """ Sets the impact of this LogAnalyticsLabelView. - label impact + The label impact. :param impact: The impact of this LogAnalyticsLabelView. @@ -369,7 +369,8 @@ def impact(self, impact): def is_system(self): """ Gets the is_system of this LogAnalyticsLabelView. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsLabelView. @@ -381,7 +382,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsLabelView. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsLabelView. @@ -393,7 +395,7 @@ def is_system(self, is_system): def name(self): """ Gets the name of this LogAnalyticsLabelView. - label name + The label name. :return: The name of this LogAnalyticsLabelView. @@ -405,7 +407,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLabelView. - label name + The label name. :param name: The name of this LogAnalyticsLabelView. @@ -417,7 +419,7 @@ def name(self, name): def priority(self): """ Gets the priority of this LogAnalyticsLabelView. - priority + The label priority. Default value is NONE. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -432,7 +434,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this LogAnalyticsLabelView. - priority + The label priority. Default value is NONE. :param priority: The priority of this LogAnalyticsLabelView. @@ -447,7 +449,7 @@ def priority(self, priority): def recommendation(self): """ Gets the recommendation of this LogAnalyticsLabelView. - recommendation + The label recommendation. :return: The recommendation of this LogAnalyticsLabelView. @@ -459,7 +461,7 @@ def recommendation(self): def recommendation(self, recommendation): """ Sets the recommendation of this LogAnalyticsLabelView. - recommendation + The label recommendation. :param recommendation: The recommendation of this LogAnalyticsLabelView. @@ -471,7 +473,7 @@ def recommendation(self, recommendation): def type(self): """ Gets the type of this LogAnalyticsLabelView. - type + The label type. :return: The type of this LogAnalyticsLabelView. @@ -483,7 +485,7 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsLabelView. - type + The label type. :param type: The type of this LogAnalyticsLabelView. @@ -495,7 +497,7 @@ def type(self, type): def is_user_deleted(self): """ Gets the is_user_deleted of this LogAnalyticsLabelView. - user deleted flag + A flag indicating whether or not the label has been deleted. :return: The is_user_deleted of this LogAnalyticsLabelView. @@ -507,7 +509,7 @@ def is_user_deleted(self): def is_user_deleted(self, is_user_deleted): """ Sets the is_user_deleted of this LogAnalyticsLabelView. - user deleted flag + A flag indicating whether or not the label has been deleted. :param is_user_deleted: The is_user_deleted of this LogAnalyticsLabelView. diff --git a/src/oci/log_analytics/models/log_analytics_log_group_summary.py b/src/oci/log_analytics/models/log_analytics_log_group_summary.py index 27e7e19356..fbf26f629f 100644 --- a/src/oci/log_analytics/models/log_analytics_log_group_summary.py +++ b/src/oci/log_analytics/models/log_analytics_log_group_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogAnalyticsLogGroupSummary(object): """ - Summary of an Log-Analytics log group. + Summary of a Log-Analytics log group. """ def __init__(self, **kwargs): diff --git a/src/oci/log_analytics/models/log_analytics_log_group_summary_collection.py b/src/oci/log_analytics/models/log_analytics_log_group_summary_collection.py index bc28a8b433..0b44ef9e0f 100644 --- a/src/oci/log_analytics/models/log_analytics_log_group_summary_collection.py +++ b/src/oci/log_analytics/models/log_analytics_log_group_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogAnalyticsLogGroupSummaryCollection(object): """ - LogAnalyticsLogGroupSummaryCollection + A collection of Log-Analytics log groups. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsLogGroupSummaryCollection. - list of log group summary objects + An array of log group summary objects. :return: The items of this LogAnalyticsLogGroupSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsLogGroupSummaryCollection. - list of log group summary objects + An array of log group summary objects. :param items: The items of this LogAnalyticsLogGroupSummaryCollection. diff --git a/src/oci/log_analytics/models/log_analytics_lookup.py b/src/oci/log_analytics/models/log_analytics_lookup.py index 81075f96bc..970430c786 100644 --- a/src/oci/log_analytics/models/log_analytics_lookup.py +++ b/src/oci/log_analytics/models/log_analytics_lookup.py @@ -145,7 +145,7 @@ def __init__(self, **kwargs): def active_edit_version(self): """ Gets the active_edit_version of this LogAnalyticsLookup. - active edit version + The active edit version. :return: The active_edit_version of this LogAnalyticsLookup. @@ -157,7 +157,7 @@ def active_edit_version(self): def active_edit_version(self, active_edit_version): """ Sets the active_edit_version of this LogAnalyticsLookup. - active edit version + The active edit version. :param active_edit_version: The active_edit_version of this LogAnalyticsLookup. @@ -169,7 +169,7 @@ def active_edit_version(self, active_edit_version): def canonical_link(self): """ Gets the canonical_link of this LogAnalyticsLookup. - canonical link + The canonical link. :return: The canonical_link of this LogAnalyticsLookup. @@ -181,7 +181,7 @@ def canonical_link(self): def canonical_link(self, canonical_link): """ Sets the canonical_link of this LogAnalyticsLookup. - canonical link + The canonical link. :param canonical_link: The canonical_link of this LogAnalyticsLookup. @@ -193,7 +193,7 @@ def canonical_link(self, canonical_link): def description(self): """ Gets the description of this LogAnalyticsLookup. - description + The lookup description. :return: The description of this LogAnalyticsLookup. @@ -205,7 +205,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsLookup. - description + The lookup description. :param description: The description of this LogAnalyticsLookup. @@ -217,7 +217,7 @@ def description(self, description): def edit_version(self): """ Gets the edit_version of this LogAnalyticsLookup. - edit version + The edit version. :return: The edit_version of this LogAnalyticsLookup. @@ -229,7 +229,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsLookup. - edit version + The edit version. :param edit_version: The edit_version of this LogAnalyticsLookup. @@ -241,7 +241,7 @@ def edit_version(self, edit_version): def fields(self): """ Gets the fields of this LogAnalyticsLookup. - fields + The lookup fields. :return: The fields of this LogAnalyticsLookup. @@ -253,7 +253,7 @@ def fields(self): def fields(self, fields): """ Sets the fields of this LogAnalyticsLookup. - fields + The lookup fields. :param fields: The fields of this LogAnalyticsLookup. @@ -343,7 +343,7 @@ def type(self, type): def name(self): """ Gets the name of this LogAnalyticsLookup. - iname + The lookup name. :return: The name of this LogAnalyticsLookup. @@ -355,7 +355,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsLookup. - iname + The lookup name. :param name: The name of this LogAnalyticsLookup. @@ -367,7 +367,8 @@ def name(self, name): def is_built_in(self): """ Gets the is_built_in of this LogAnalyticsLookup. - is built in + A flag indicating if the lookup is custom (user-defined) or + built in. :return: The is_built_in of this LogAnalyticsLookup. @@ -379,7 +380,8 @@ def is_built_in(self): def is_built_in(self, is_built_in): """ Sets the is_built_in of this LogAnalyticsLookup. - is built in + A flag indicating if the lookup is custom (user-defined) or + built in. :param is_built_in: The is_built_in of this LogAnalyticsLookup. @@ -391,7 +393,8 @@ def is_built_in(self, is_built_in): def is_hidden(self): """ Gets the is_hidden of this LogAnalyticsLookup. - is hidden + A flag indicating if the lookup is hidden or not. A hidden lookup will + not be returned in list operations by default. :return: The is_hidden of this LogAnalyticsLookup. @@ -403,7 +406,8 @@ def is_hidden(self): def is_hidden(self, is_hidden): """ Sets the is_hidden of this LogAnalyticsLookup. - is hidden + A flag indicating if the lookup is hidden or not. A hidden lookup will + not be returned in list operations by default. :param is_hidden: The is_hidden of this LogAnalyticsLookup. @@ -415,7 +419,7 @@ def is_hidden(self, is_hidden): def lookup_display_name(self): """ Gets the lookup_display_name of this LogAnalyticsLookup. - name + The lookup display name. :return: The lookup_display_name of this LogAnalyticsLookup. @@ -427,7 +431,7 @@ def lookup_display_name(self): def lookup_display_name(self, lookup_display_name): """ Sets the lookup_display_name of this LogAnalyticsLookup. - name + The lookup display name. :param lookup_display_name: The lookup_display_name of this LogAnalyticsLookup. @@ -479,7 +483,7 @@ def status_summary(self, status_summary): def time_updated(self): """ Gets the time_updated of this LogAnalyticsLookup. - last updated date + The last updated date. :return: The time_updated of this LogAnalyticsLookup. @@ -491,7 +495,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsLookup. - last updated date + The last updated date. :param time_updated: The time_updated of this LogAnalyticsLookup. diff --git a/src/oci/log_analytics/models/log_analytics_meta_function.py b/src/oci/log_analytics/models/log_analytics_meta_function.py index f455ff0da7..5948386336 100644 --- a/src/oci/log_analytics/models/log_analytics_meta_function.py +++ b/src/oci/log_analytics/models/log_analytics_meta_function.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def meta_function_argument(self): """ Gets the meta_function_argument of this LogAnalyticsMetaFunction. - meta function argument object + An array of meta function arguments. :return: The meta_function_argument of this LogAnalyticsMetaFunction. @@ -91,7 +91,7 @@ def meta_function_argument(self): def meta_function_argument(self, meta_function_argument): """ Sets the meta_function_argument of this LogAnalyticsMetaFunction. - meta function argument object + An array of meta function arguments. :param meta_function_argument: The meta_function_argument of this LogAnalyticsMetaFunction. @@ -103,7 +103,7 @@ def meta_function_argument(self, meta_function_argument): def component(self): """ Gets the component of this LogAnalyticsMetaFunction. - component + The component. :return: The component of this LogAnalyticsMetaFunction. @@ -115,7 +115,7 @@ def component(self): def component(self, component): """ Sets the component of this LogAnalyticsMetaFunction. - component + The component. :param component: The component of this LogAnalyticsMetaFunction. @@ -127,7 +127,7 @@ def component(self, component): def description(self): """ Gets the description of this LogAnalyticsMetaFunction. - description + The description. :return: The description of this LogAnalyticsMetaFunction. @@ -139,7 +139,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsMetaFunction. - description + The description. :param description: The description of this LogAnalyticsMetaFunction. @@ -151,7 +151,7 @@ def description(self, description): def edit_version(self): """ Gets the edit_version of this LogAnalyticsMetaFunction. - edit version + The edit version. :return: The edit_version of this LogAnalyticsMetaFunction. @@ -163,7 +163,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsMetaFunction. - edit version + The edit version. :param edit_version: The edit_version of this LogAnalyticsMetaFunction. @@ -175,7 +175,7 @@ def edit_version(self, edit_version): def meta_function_id(self): """ Gets the meta_function_id of this LogAnalyticsMetaFunction. - meta function Id + The meta function unique identifier. :return: The meta_function_id of this LogAnalyticsMetaFunction. @@ -187,7 +187,7 @@ def meta_function_id(self): def meta_function_id(self, meta_function_id): """ Sets the meta_function_id of this LogAnalyticsMetaFunction. - meta function Id + The meta function unique identifier. :param meta_function_id: The meta_function_id of this LogAnalyticsMetaFunction. @@ -199,7 +199,7 @@ def meta_function_id(self, meta_function_id): def java_class_name(self): """ Gets the java_class_name of this LogAnalyticsMetaFunction. - java class name + The java class name. :return: The java_class_name of this LogAnalyticsMetaFunction. @@ -211,7 +211,7 @@ def java_class_name(self): def java_class_name(self, java_class_name): """ Sets the java_class_name of this LogAnalyticsMetaFunction. - java class name + The java class name. :param java_class_name: The java_class_name of this LogAnalyticsMetaFunction. @@ -223,7 +223,7 @@ def java_class_name(self, java_class_name): def name(self): """ Gets the name of this LogAnalyticsMetaFunction. - meta function name + The meta function name. :return: The name of this LogAnalyticsMetaFunction. @@ -235,7 +235,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsMetaFunction. - meta function name + The meta function name. :param name: The name of this LogAnalyticsMetaFunction. diff --git a/src/oci/log_analytics/models/log_analytics_meta_function_argument.py b/src/oci/log_analytics/models/log_analytics_meta_function_argument.py index 30d30e7bc6..a530699278 100644 --- a/src/oci/log_analytics/models/log_analytics_meta_function_argument.py +++ b/src/oci/log_analytics/models/log_analytics_meta_function_argument.py @@ -70,6 +70,10 @@ def __init__(self, **kwargs): The value to assign to the argument_value property of this LogAnalyticsMetaFunctionArgument. :type argument_value: str + :param argument_reference: + The value to assign to the argument_reference property of this LogAnalyticsMetaFunctionArgument. + :type argument_reference: str + """ self.swagger_types = { 'is_override_output_fields': 'bool', @@ -84,7 +88,8 @@ def __init__(self, **kwargs): 'argument_id': 'int', 'argument_lookup_column': 'str', 'argument_lookup_column_position': 'int', - 'argument_value': 'str' + 'argument_value': 'str', + 'argument_reference': 'str' } self.attribute_map = { @@ -100,7 +105,8 @@ def __init__(self, **kwargs): 'argument_id': 'argumentId', 'argument_lookup_column': 'argumentLookupColumn', 'argument_lookup_column_position': 'argumentLookupColumnPosition', - 'argument_value': 'argumentValue' + 'argument_value': 'argumentValue', + 'argument_reference': 'argumentReference' } self._is_override_output_fields = None @@ -116,12 +122,13 @@ def __init__(self, **kwargs): self._argument_lookup_column = None self._argument_lookup_column_position = None self._argument_value = None + self._argument_reference = None @property def is_override_output_fields(self): """ Gets the is_override_output_fields of this LogAnalyticsMetaFunctionArgument. - override output fields + The override output fields. :return: The is_override_output_fields of this LogAnalyticsMetaFunctionArgument. @@ -133,7 +140,7 @@ def is_override_output_fields(self): def is_override_output_fields(self, is_override_output_fields): """ Sets the is_override_output_fields of this LogAnalyticsMetaFunctionArgument. - override output fields + The override output fields. :param is_override_output_fields: The is_override_output_fields of this LogAnalyticsMetaFunctionArgument. @@ -145,7 +152,7 @@ def is_override_output_fields(self, is_override_output_fields): def argument_display_name(self): """ Gets the argument_display_name of this LogAnalyticsMetaFunctionArgument. - argument display name + The argument display name. :return: The argument_display_name of this LogAnalyticsMetaFunctionArgument. @@ -157,7 +164,7 @@ def argument_display_name(self): def argument_display_name(self, argument_display_name): """ Sets the argument_display_name of this LogAnalyticsMetaFunctionArgument. - argument display name + The argument display name. :param argument_display_name: The argument_display_name of this LogAnalyticsMetaFunctionArgument. @@ -169,7 +176,7 @@ def argument_display_name(self, argument_display_name): def argument_example(self): """ Gets the argument_example of this LogAnalyticsMetaFunctionArgument. - argument example + The argument example. :return: The argument_example of this LogAnalyticsMetaFunctionArgument. @@ -181,7 +188,7 @@ def argument_example(self): def argument_example(self, argument_example): """ Sets the argument_example of this LogAnalyticsMetaFunctionArgument. - argument example + The argument example. :param argument_example: The argument_example of this LogAnalyticsMetaFunctionArgument. @@ -193,7 +200,7 @@ def argument_example(self, argument_example): def argument_service(self): """ Gets the argument_service of this LogAnalyticsMetaFunctionArgument. - argument service + The argument service. :return: The argument_service of this LogAnalyticsMetaFunctionArgument. @@ -205,7 +212,7 @@ def argument_service(self): def argument_service(self, argument_service): """ Sets the argument_service of this LogAnalyticsMetaFunctionArgument. - argument service + The argument service. :param argument_service: The argument_service of this LogAnalyticsMetaFunctionArgument. @@ -217,7 +224,7 @@ def argument_service(self, argument_service): def argument_data_type(self): """ Gets the argument_data_type of this LogAnalyticsMetaFunctionArgument. - argument data type + The argument data type. :return: The argument_data_type of this LogAnalyticsMetaFunctionArgument. @@ -229,7 +236,7 @@ def argument_data_type(self): def argument_data_type(self, argument_data_type): """ Sets the argument_data_type of this LogAnalyticsMetaFunctionArgument. - argument data type + The argument data type. :param argument_data_type: The argument_data_type of this LogAnalyticsMetaFunctionArgument. @@ -241,7 +248,7 @@ def argument_data_type(self, argument_data_type): def argument_description(self): """ Gets the argument_description of this LogAnalyticsMetaFunctionArgument. - argument description + The argument description. :return: The argument_description of this LogAnalyticsMetaFunctionArgument. @@ -253,7 +260,7 @@ def argument_description(self): def argument_description(self, argument_description): """ Sets the argument_description of this LogAnalyticsMetaFunctionArgument. - argument description + The argument description. :param argument_description: The argument_description of this LogAnalyticsMetaFunctionArgument. @@ -265,7 +272,7 @@ def argument_description(self, argument_description): def argument_name(self): """ Gets the argument_name of this LogAnalyticsMetaFunctionArgument. - argument name + The argument name. :return: The argument_name of this LogAnalyticsMetaFunctionArgument. @@ -277,7 +284,7 @@ def argument_name(self): def argument_name(self, argument_name): """ Sets the argument_name of this LogAnalyticsMetaFunctionArgument. - argument name + The argument name. :param argument_name: The argument_name of this LogAnalyticsMetaFunctionArgument. @@ -289,7 +296,7 @@ def argument_name(self, argument_name): def argument_order(self): """ Gets the argument_order of this LogAnalyticsMetaFunctionArgument. - argument order + The argument order. :return: The argument_order of this LogAnalyticsMetaFunctionArgument. @@ -301,7 +308,7 @@ def argument_order(self): def argument_order(self, argument_order): """ Sets the argument_order of this LogAnalyticsMetaFunctionArgument. - argument order + The argument order. :param argument_order: The argument_order of this LogAnalyticsMetaFunctionArgument. @@ -313,7 +320,7 @@ def argument_order(self, argument_order): def argument_type(self): """ Gets the argument_type of this LogAnalyticsMetaFunctionArgument. - argument type + The argument type. :return: The argument_type of this LogAnalyticsMetaFunctionArgument. @@ -325,7 +332,7 @@ def argument_type(self): def argument_type(self, argument_type): """ Sets the argument_type of this LogAnalyticsMetaFunctionArgument. - argument type + The argument type. :param argument_type: The argument_type of this LogAnalyticsMetaFunctionArgument. @@ -337,7 +344,7 @@ def argument_type(self, argument_type): def argument_id(self): """ Gets the argument_id of this LogAnalyticsMetaFunctionArgument. - meta function id + The argument unique identifier. :return: The argument_id of this LogAnalyticsMetaFunctionArgument. @@ -349,7 +356,7 @@ def argument_id(self): def argument_id(self, argument_id): """ Sets the argument_id of this LogAnalyticsMetaFunctionArgument. - meta function id + The argument unique identifier. :param argument_id: The argument_id of this LogAnalyticsMetaFunctionArgument. @@ -361,7 +368,7 @@ def argument_id(self, argument_id): def argument_lookup_column(self): """ Gets the argument_lookup_column of this LogAnalyticsMetaFunctionArgument. - column + The lookup column. :return: The argument_lookup_column of this LogAnalyticsMetaFunctionArgument. @@ -373,7 +380,7 @@ def argument_lookup_column(self): def argument_lookup_column(self, argument_lookup_column): """ Sets the argument_lookup_column of this LogAnalyticsMetaFunctionArgument. - column + The lookup column. :param argument_lookup_column: The argument_lookup_column of this LogAnalyticsMetaFunctionArgument. @@ -385,7 +392,7 @@ def argument_lookup_column(self, argument_lookup_column): def argument_lookup_column_position(self): """ Gets the argument_lookup_column_position of this LogAnalyticsMetaFunctionArgument. - column position + The lookup column position. :return: The argument_lookup_column_position of this LogAnalyticsMetaFunctionArgument. @@ -397,7 +404,7 @@ def argument_lookup_column_position(self): def argument_lookup_column_position(self, argument_lookup_column_position): """ Sets the argument_lookup_column_position of this LogAnalyticsMetaFunctionArgument. - column position + The lookup column position. :param argument_lookup_column_position: The argument_lookup_column_position of this LogAnalyticsMetaFunctionArgument. @@ -409,7 +416,7 @@ def argument_lookup_column_position(self, argument_lookup_column_position): def argument_value(self): """ Gets the argument_value of this LogAnalyticsMetaFunctionArgument. - value + The argument value. :return: The argument_value of this LogAnalyticsMetaFunctionArgument. @@ -421,7 +428,7 @@ def argument_value(self): def argument_value(self, argument_value): """ Sets the argument_value of this LogAnalyticsMetaFunctionArgument. - value + The argument value. :param argument_value: The argument_value of this LogAnalyticsMetaFunctionArgument. @@ -429,6 +436,30 @@ def argument_value(self, argument_value): """ self._argument_value = argument_value + @property + def argument_reference(self): + """ + Gets the argument_reference of this LogAnalyticsMetaFunctionArgument. + The argument unique identifier as a string. + + + :return: The argument_reference of this LogAnalyticsMetaFunctionArgument. + :rtype: str + """ + return self._argument_reference + + @argument_reference.setter + def argument_reference(self, argument_reference): + """ + Sets the argument_reference of this LogAnalyticsMetaFunctionArgument. + The argument unique identifier as a string. + + + :param argument_reference: The argument_reference of this LogAnalyticsMetaFunctionArgument. + :type: str + """ + self._argument_reference = argument_reference + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/log_analytics_meta_function_collection.py b/src/oci/log_analytics/models/log_analytics_meta_function_collection.py index e01216a513..eca26f318b 100644 --- a/src/oci/log_analytics/models/log_analytics_meta_function_collection.py +++ b/src/oci/log_analytics/models/log_analytics_meta_function_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsMetaFunctionCollection. - list of meta functions + An array of meta functions. :return: The items of this LogAnalyticsMetaFunctionCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsMetaFunctionCollection. - list of meta functions + An array of meta functions. :param items: The items of this LogAnalyticsMetaFunctionCollection. diff --git a/src/oci/log_analytics/models/log_analytics_meta_source_type.py b/src/oci/log_analytics/models/log_analytics_meta_source_type.py index 50027e0bfb..352cd1c992 100644 --- a/src/oci/log_analytics/models/log_analytics_meta_source_type.py +++ b/src/oci/log_analytics/models/log_analytics_meta_source_type.py @@ -86,7 +86,7 @@ def __init__(self, **kwargs): def built_in_parser_name(self): """ Gets the built_in_parser_name of this LogAnalyticsMetaSourceType. - built in parser name + The built in parser name. :return: The built_in_parser_name of this LogAnalyticsMetaSourceType. @@ -98,7 +98,7 @@ def built_in_parser_name(self): def built_in_parser_name(self, built_in_parser_name): """ Sets the built_in_parser_name of this LogAnalyticsMetaSourceType. - built in parser name + The built in parser name. :param built_in_parser_name: The built_in_parser_name of this LogAnalyticsMetaSourceType. @@ -110,7 +110,7 @@ def built_in_parser_name(self, built_in_parser_name): def description(self): """ Gets the description of this LogAnalyticsMetaSourceType. - type description + The source type description. :return: The description of this LogAnalyticsMetaSourceType. @@ -122,7 +122,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsMetaSourceType. - type description + The source type description. :param description: The description of this LogAnalyticsMetaSourceType. @@ -134,7 +134,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsMetaSourceType. - display name + The source type display name. :return: The display_name of this LogAnalyticsMetaSourceType. @@ -146,7 +146,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsMetaSourceType. - display name + The source type display name. :param display_name: The display_name of this LogAnalyticsMetaSourceType. @@ -158,7 +158,7 @@ def display_name(self, display_name): def entity_display_name(self): """ Gets the entity_display_name of this LogAnalyticsMetaSourceType. - entity display name + The entity display name. :return: The entity_display_name of this LogAnalyticsMetaSourceType. @@ -170,7 +170,7 @@ def entity_display_name(self): def entity_display_name(self, entity_display_name): """ Sets the entity_display_name of this LogAnalyticsMetaSourceType. - entity display name + The entity display name. :param entity_display_name: The entity_display_name of this LogAnalyticsMetaSourceType. @@ -182,7 +182,7 @@ def entity_display_name(self, entity_display_name): def entity_name(self): """ Gets the entity_name of this LogAnalyticsMetaSourceType. - entity name + The entity internal name. :return: The entity_name of this LogAnalyticsMetaSourceType. @@ -194,7 +194,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this LogAnalyticsMetaSourceType. - entity name + The entity internal name. :param entity_name: The entity_name of this LogAnalyticsMetaSourceType. @@ -206,7 +206,7 @@ def entity_name(self, entity_name): def name(self): """ Gets the name of this LogAnalyticsMetaSourceType. - source type name + The source type name. :return: The name of this LogAnalyticsMetaSourceType. @@ -218,7 +218,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsMetaSourceType. - source type name + The source type name. :param name: The name of this LogAnalyticsMetaSourceType. @@ -230,7 +230,7 @@ def name(self, name): def maximum_exclude_pattern(self): """ Gets the maximum_exclude_pattern of this LogAnalyticsMetaSourceType. - maximum exclude pattern + The maximum exclude pattern. :return: The maximum_exclude_pattern of this LogAnalyticsMetaSourceType. @@ -242,7 +242,7 @@ def maximum_exclude_pattern(self): def maximum_exclude_pattern(self, maximum_exclude_pattern): """ Sets the maximum_exclude_pattern of this LogAnalyticsMetaSourceType. - maximum exclude pattern + The maximum exclude pattern. :param maximum_exclude_pattern: The maximum_exclude_pattern of this LogAnalyticsMetaSourceType. @@ -254,7 +254,7 @@ def maximum_exclude_pattern(self, maximum_exclude_pattern): def maximum_include_pattern(self): """ Gets the maximum_include_pattern of this LogAnalyticsMetaSourceType. - maximum include pattern + The maximum include pattern. :return: The maximum_include_pattern of this LogAnalyticsMetaSourceType. @@ -266,7 +266,7 @@ def maximum_include_pattern(self): def maximum_include_pattern(self, maximum_include_pattern): """ Sets the maximum_include_pattern of this LogAnalyticsMetaSourceType. - maximum include pattern + The maximum include pattern. :param maximum_include_pattern: The maximum_include_pattern of this LogAnalyticsMetaSourceType. diff --git a/src/oci/log_analytics/models/log_analytics_meta_source_type_collection.py b/src/oci/log_analytics/models/log_analytics_meta_source_type_collection.py index e9fe524185..c88aad8038 100644 --- a/src/oci/log_analytics/models/log_analytics_meta_source_type_collection.py +++ b/src/oci/log_analytics/models/log_analytics_meta_source_type_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsMetaSourceTypeCollection. - list of tag priorities + An array of meta source types. :return: The items of this LogAnalyticsMetaSourceTypeCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsMetaSourceTypeCollection. - list of tag priorities + An array of meta source types. :param items: The items of this LogAnalyticsMetaSourceTypeCollection. diff --git a/src/oci/log_analytics/models/log_analytics_metric.py b/src/oci/log_analytics/models/log_analytics_metric.py index ca553760f2..4cdeaec9bf 100644 --- a/src/oci/log_analytics/models/log_analytics_metric.py +++ b/src/oci/log_analytics/models/log_analytics_metric.py @@ -221,7 +221,7 @@ def __init__(self, **kwargs): def aggregation_field(self): """ Gets the aggregation_field of this LogAnalyticsMetric. - aggregation field + The aggregation field. :return: The aggregation_field of this LogAnalyticsMetric. @@ -233,7 +233,7 @@ def aggregation_field(self): def aggregation_field(self, aggregation_field): """ Sets the aggregation_field of this LogAnalyticsMetric. - aggregation field + The aggregation field. :param aggregation_field: The aggregation_field of this LogAnalyticsMetric. @@ -245,7 +245,7 @@ def aggregation_field(self, aggregation_field): def bucket_metadata(self): """ Gets the bucket_metadata of this LogAnalyticsMetric. - bucket metadata + The bucket metadata. :return: The bucket_metadata of this LogAnalyticsMetric. @@ -257,7 +257,7 @@ def bucket_metadata(self): def bucket_metadata(self, bucket_metadata): """ Sets the bucket_metadata of this LogAnalyticsMetric. - bucket metadata + The bucket metadata. :param bucket_metadata: The bucket_metadata of this LogAnalyticsMetric. @@ -269,7 +269,7 @@ def bucket_metadata(self, bucket_metadata): def clock_period(self): """ Gets the clock_period of this LogAnalyticsMetric. - clock period + The clock period. :return: The clock_period of this LogAnalyticsMetric. @@ -281,7 +281,7 @@ def clock_period(self): def clock_period(self, clock_period): """ Sets the clock_period of this LogAnalyticsMetric. - clock period + The clock period. :param clock_period: The clock_period of this LogAnalyticsMetric. @@ -293,7 +293,7 @@ def clock_period(self, clock_period): def description(self): """ Gets the description of this LogAnalyticsMetric. - description + The metric description. :return: The description of this LogAnalyticsMetric. @@ -305,7 +305,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsMetric. - description + The metric description. :param description: The description of this LogAnalyticsMetric. @@ -317,7 +317,7 @@ def description(self, description): def edit_version(self): """ Gets the edit_version of this LogAnalyticsMetric. - edit version + The metric edit version. :return: The edit_version of this LogAnalyticsMetric. @@ -329,7 +329,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsMetric. - edit version + The metric edit version. :param edit_version: The edit_version of this LogAnalyticsMetric. @@ -341,7 +341,7 @@ def edit_version(self, edit_version): def field_name(self): """ Gets the field_name of this LogAnalyticsMetric. - field name + The field name. :return: The field_name of this LogAnalyticsMetric. @@ -353,7 +353,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this LogAnalyticsMetric. - field name + The field name. :param field_name: The field_name of this LogAnalyticsMetric. @@ -365,7 +365,7 @@ def field_name(self, field_name): def field_values(self): """ Gets the field_values of this LogAnalyticsMetric. - field value array + The field values. :return: The field_values of this LogAnalyticsMetric. @@ -377,7 +377,7 @@ def field_values(self): def field_values(self, field_values): """ Sets the field_values of this LogAnalyticsMetric. - field value array + The field values. :param field_values: The field_values of this LogAnalyticsMetric. @@ -389,7 +389,7 @@ def field_values(self, field_values): def grouping_field(self): """ Gets the grouping_field of this LogAnalyticsMetric. - grouping fields + The grouping fields. :return: The grouping_field of this LogAnalyticsMetric. @@ -401,7 +401,7 @@ def grouping_field(self): def grouping_field(self, grouping_field): """ Sets the grouping_field of this LogAnalyticsMetric. - grouping fields + The grouping fields. :param grouping_field: The grouping_field of this LogAnalyticsMetric. @@ -413,7 +413,7 @@ def grouping_field(self, grouping_field): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsMetric. - is enabled flag + A flag inidcating whether or not the metric is enabled. :return: The is_enabled of this LogAnalyticsMetric. @@ -425,7 +425,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsMetric. - is enabled flag + A flag inidcating whether or not the metric is enabled. :param is_enabled: The is_enabled of this LogAnalyticsMetric. @@ -437,7 +437,8 @@ def is_enabled(self, is_enabled): def is_system(self): """ Gets the is_system of this LogAnalyticsMetric. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsMetric. @@ -449,7 +450,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsMetric. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsMetric. @@ -461,7 +463,7 @@ def is_system(self, is_system): def display_name(self): """ Gets the display_name of this LogAnalyticsMetric. - metric display name + The metric display name. :return: The display_name of this LogAnalyticsMetric. @@ -473,7 +475,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsMetric. - metric display name + The metric display name. :param display_name: The display_name of this LogAnalyticsMetric. @@ -485,7 +487,7 @@ def display_name(self, display_name): def metric_reference(self): """ Gets the metric_reference of this LogAnalyticsMetric. - metric Id + The metric unique identifier. :return: The metric_reference of this LogAnalyticsMetric. @@ -497,7 +499,7 @@ def metric_reference(self): def metric_reference(self, metric_reference): """ Sets the metric_reference of this LogAnalyticsMetric. - metric Id + The metric unique identifier. :param metric_reference: The metric_reference of this LogAnalyticsMetric. @@ -509,7 +511,7 @@ def metric_reference(self, metric_reference): def name(self): """ Gets the name of this LogAnalyticsMetric. - name + The metric name. :return: The name of this LogAnalyticsMetric. @@ -521,7 +523,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsMetric. - name + The metric name. :param name: The name of this LogAnalyticsMetric. @@ -533,7 +535,8 @@ def name(self, name): def metric_type(self): """ Gets the metric_type of this LogAnalyticsMetric. - metric type + The metric type, specifying the type of aggreation to perform. Default value + is COUNT. Allowed values for this property are: "COUNT", "SUM", "AVERAGE", "COUNT_DISTRIBUTION", "SUM_DISTRIBUTION", "AVERAGE_DISTRIBUTION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -548,7 +551,8 @@ def metric_type(self): def metric_type(self, metric_type): """ Sets the metric_type of this LogAnalyticsMetric. - metric type + The metric type, specifying the type of aggreation to perform. Default value + is COUNT. :param metric_type: The metric_type of this LogAnalyticsMetric. @@ -563,7 +567,7 @@ def metric_type(self, metric_type): def is_metric_source_enabled(self): """ Gets the is_metric_source_enabled of this LogAnalyticsMetric. - is metric source map enabled flag + A flag specifying whether or not the metric source is enabled. :return: The is_metric_source_enabled of this LogAnalyticsMetric. @@ -575,7 +579,7 @@ def is_metric_source_enabled(self): def is_metric_source_enabled(self, is_metric_source_enabled): """ Sets the is_metric_source_enabled of this LogAnalyticsMetric. - is metric source map enabled flag + A flag specifying whether or not the metric source is enabled. :param is_metric_source_enabled: The is_metric_source_enabled of this LogAnalyticsMetric. @@ -587,7 +591,7 @@ def is_metric_source_enabled(self, is_metric_source_enabled): def operator(self): """ Gets the operator of this LogAnalyticsMetric. - operator + The metric operator. Allowed values for this property are: "CONTAINS_IGNORE_CASE", "IN_IGNORE_CASE", "EQUAL_IGNORE_CASE", "NOT_NULL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -602,7 +606,7 @@ def operator(self): def operator(self, operator): """ Sets the operator of this LogAnalyticsMetric. - operator + The metric operator. :param operator: The operator of this LogAnalyticsMetric. @@ -617,7 +621,7 @@ def operator(self, operator): def sources(self): """ Gets the sources of this LogAnalyticsMetric. - sources + The metric sources. :return: The sources of this LogAnalyticsMetric. @@ -629,7 +633,7 @@ def sources(self): def sources(self, sources): """ Sets the sources of this LogAnalyticsMetric. - sources + The metric sources. :param sources: The sources of this LogAnalyticsMetric. @@ -641,7 +645,7 @@ def sources(self, sources): def entity_type(self): """ Gets the entity_type of this LogAnalyticsMetric. - entity type + The entity type. :return: The entity_type of this LogAnalyticsMetric. @@ -653,7 +657,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsMetric. - entity type + The entity type. :param entity_type: The entity_type of this LogAnalyticsMetric. @@ -665,7 +669,7 @@ def entity_type(self, entity_type): def time_updated(self): """ Gets the time_updated of this LogAnalyticsMetric. - last updated date + The last updated date. :return: The time_updated of this LogAnalyticsMetric. @@ -677,7 +681,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsMetric. - last updated date + The last updated date. :param time_updated: The time_updated of this LogAnalyticsMetric. @@ -689,7 +693,7 @@ def time_updated(self, time_updated): def unit_type(self): """ Gets the unit_type of this LogAnalyticsMetric. - unit type + The unit type. :return: The unit_type of this LogAnalyticsMetric. @@ -701,7 +705,7 @@ def unit_type(self): def unit_type(self, unit_type): """ Sets the unit_type of this LogAnalyticsMetric. - unit type + The unit type. :param unit_type: The unit_type of this LogAnalyticsMetric. @@ -713,7 +717,7 @@ def unit_type(self, unit_type): def is_user_customized(self): """ Gets the is_user_customized of this LogAnalyticsMetric. - user customized + A flag specifying whether or not this is a custom (user defined) metric. :return: The is_user_customized of this LogAnalyticsMetric. @@ -725,7 +729,7 @@ def is_user_customized(self): def is_user_customized(self, is_user_customized): """ Sets the is_user_customized of this LogAnalyticsMetric. - user customized + A flag specifying whether or not this is a custom (user defined) metric. :param is_user_customized: The is_user_customized of this LogAnalyticsMetric. diff --git a/src/oci/log_analytics/models/log_analytics_object_collection_rule.py b/src/oci/log_analytics/models/log_analytics_object_collection_rule.py index 75c3017154..a2ccc4ad73 100644 --- a/src/oci/log_analytics/models/log_analytics_object_collection_rule.py +++ b/src/oci/log_analytics/models/log_analytics_object_collection_rule.py @@ -548,7 +548,7 @@ def overrides(self): """ Gets the overrides of this LogAnalyticsObjectCollectionRule. Use this to override some property values which are defined at bucket level to the scope of object. - Supported propeties for override are, logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". @@ -562,7 +562,7 @@ def overrides(self, overrides): """ Sets the overrides of this LogAnalyticsObjectCollectionRule. Use this to override some property values which are defined at bucket level to the scope of object. - Supported propeties for override are, logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". diff --git a/src/oci/log_analytics/models/log_analytics_parameter.py b/src/oci/log_analytics/models/log_analytics_parameter.py index 8cacf4a77c..e7f03fdbff 100644 --- a/src/oci/log_analytics/models/log_analytics_parameter.py +++ b/src/oci/log_analytics/models/log_analytics_parameter.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def default_value(self): """ Gets the default_value of this LogAnalyticsParameter. - default value + The default value of the parameter. :return: The default_value of this LogAnalyticsParameter. @@ -77,7 +77,7 @@ def default_value(self): def default_value(self, default_value): """ Sets the default_value of this LogAnalyticsParameter. - default value + The default value of the parameter. :param default_value: The default_value of this LogAnalyticsParameter. @@ -89,7 +89,7 @@ def default_value(self, default_value): def description(self): """ Gets the description of this LogAnalyticsParameter. - description + The parameter description. :return: The description of this LogAnalyticsParameter. @@ -101,7 +101,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsParameter. - description + The parameter description. :param description: The description of this LogAnalyticsParameter. @@ -113,7 +113,7 @@ def description(self, description): def is_active(self): """ Gets the is_active of this LogAnalyticsParameter. - is active flag + A flag indicating whether or not the parameter is active. :return: The is_active of this LogAnalyticsParameter. @@ -125,7 +125,7 @@ def is_active(self): def is_active(self, is_active): """ Sets the is_active of this LogAnalyticsParameter. - is active flag + A flag indicating whether or not the parameter is active. :param is_active: The is_active of this LogAnalyticsParameter. @@ -137,7 +137,7 @@ def is_active(self, is_active): def name(self): """ Gets the name of this LogAnalyticsParameter. - parameter name + The parameter name. :return: The name of this LogAnalyticsParameter. @@ -149,7 +149,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsParameter. - parameter name + The parameter name. :param name: The name of this LogAnalyticsParameter. @@ -161,7 +161,7 @@ def name(self, name): def source_id(self): """ Gets the source_id of this LogAnalyticsParameter. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsParameter. @@ -173,7 +173,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsParameter. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsParameter. diff --git a/src/oci/log_analytics/models/log_analytics_parser.py b/src/oci/log_analytics/models/log_analytics_parser.py index 9243755410..86c28f4be5 100644 --- a/src/oci/log_analytics/models/log_analytics_parser.py +++ b/src/oci/log_analytics/models/log_analytics_parser.py @@ -29,6 +29,10 @@ class LogAnalyticsParser(object): #: This constant has a value of "ODL" TYPE_ODL = "ODL" + #: A constant which can be used with the type property of a LogAnalyticsParser. + #: This constant has a value of "DELIMITED" + TYPE_DELIMITED = "DELIMITED" + def __init__(self, **kwargs): """ Initializes a new LogAnalyticsParser object with values from keyword arguments. @@ -142,9 +146,17 @@ def __init__(self, **kwargs): The value to assign to the should_tokenize_original_text property of this LogAnalyticsParser. :type should_tokenize_original_text: bool + :param field_delimiter: + The value to assign to the field_delimiter property of this LogAnalyticsParser. + :type field_delimiter: str + + :param field_qualifier: + The value to assign to the field_qualifier property of this LogAnalyticsParser. + :type field_qualifier: str + :param type: The value to assign to the type property of this LogAnalyticsParser. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type type: str @@ -181,6 +193,8 @@ def __init__(self, **kwargs): 'sources_count': 'int', 'sources': 'list[LogAnalyticsSource]', 'should_tokenize_original_text': 'bool', + 'field_delimiter': 'str', + 'field_qualifier': 'str', 'type': 'str', 'is_user_deleted': 'bool' } @@ -213,6 +227,8 @@ def __init__(self, **kwargs): 'sources_count': 'sourcesCount', 'sources': 'sources', 'should_tokenize_original_text': 'shouldTokenizeOriginalText', + 'field_delimiter': 'fieldDelimiter', + 'field_qualifier': 'fieldQualifier', 'type': 'type', 'is_user_deleted': 'isUserDeleted' } @@ -244,6 +260,8 @@ def __init__(self, **kwargs): self._sources_count = None self._sources = None self._should_tokenize_original_text = None + self._field_delimiter = None + self._field_qualifier = None self._type = None self._is_user_deleted = None @@ -251,7 +269,7 @@ def __init__(self, **kwargs): def content(self): """ Gets the content of this LogAnalyticsParser. - content + The content. :return: The content of this LogAnalyticsParser. @@ -263,7 +281,7 @@ def content(self): def content(self, content): """ Sets the content of this LogAnalyticsParser. - content + The content. :param content: The content of this LogAnalyticsParser. @@ -275,7 +293,7 @@ def content(self, content): def description(self): """ Gets the description of this LogAnalyticsParser. - description + The parser description. :return: The description of this LogAnalyticsParser. @@ -287,7 +305,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsParser. - description + The parser description. :param description: The description of this LogAnalyticsParser. @@ -299,7 +317,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsParser. - display name + The parser display name. :return: The display_name of this LogAnalyticsParser. @@ -311,7 +329,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsParser. - display name + The parser display name. :param display_name: The display_name of this LogAnalyticsParser. @@ -323,7 +341,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsParser. - edit version + The parser edit version. :return: The edit_version of this LogAnalyticsParser. @@ -335,7 +353,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsParser. - edit version + The parser edit version. :param edit_version: The edit_version of this LogAnalyticsParser. @@ -347,7 +365,7 @@ def edit_version(self, edit_version): def encoding(self): """ Gets the encoding of this LogAnalyticsParser. - encoding + The encoding. :return: The encoding of this LogAnalyticsParser. @@ -359,7 +377,7 @@ def encoding(self): def encoding(self, encoding): """ Sets the encoding of this LogAnalyticsParser. - encoding + The encoding. :param encoding: The encoding of this LogAnalyticsParser. @@ -371,7 +389,7 @@ def encoding(self, encoding): def example_content(self): """ Gets the example_content of this LogAnalyticsParser. - example content + The example content. :return: The example_content of this LogAnalyticsParser. @@ -383,7 +401,7 @@ def example_content(self): def example_content(self, example_content): """ Sets the example_content of this LogAnalyticsParser. - example content + The example content. :param example_content: The example_content of this LogAnalyticsParser. @@ -395,7 +413,7 @@ def example_content(self, example_content): def field_maps(self): """ Gets the field_maps of this LogAnalyticsParser. - fields Maps + The parser fields. :return: The field_maps of this LogAnalyticsParser. @@ -407,7 +425,7 @@ def field_maps(self): def field_maps(self, field_maps): """ Sets the field_maps of this LogAnalyticsParser. - fields Maps + The parser fields. :param field_maps: The field_maps of this LogAnalyticsParser. @@ -419,7 +437,7 @@ def field_maps(self, field_maps): def footer_content(self): """ Gets the footer_content of this LogAnalyticsParser. - footer regular expression + The footer regular expression. :return: The footer_content of this LogAnalyticsParser. @@ -431,7 +449,7 @@ def footer_content(self): def footer_content(self, footer_content): """ Sets the footer_content of this LogAnalyticsParser. - footer regular expression + The footer regular expression. :param footer_content: The footer_content of this LogAnalyticsParser. @@ -443,7 +461,7 @@ def footer_content(self, footer_content): def header_content(self): """ Gets the header_content of this LogAnalyticsParser. - header content + The header content. :return: The header_content of this LogAnalyticsParser. @@ -455,7 +473,7 @@ def header_content(self): def header_content(self, header_content): """ Sets the header_content of this LogAnalyticsParser. - header content + The header content. :param header_content: The header_content of this LogAnalyticsParser. @@ -467,7 +485,7 @@ def header_content(self, header_content): def name(self): """ Gets the name of this LogAnalyticsParser. - Name + The parser name. :return: The name of this LogAnalyticsParser. @@ -479,7 +497,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsParser. - Name + The parser name. :param name: The name of this LogAnalyticsParser. @@ -491,7 +509,7 @@ def name(self, name): def is_default(self): """ Gets the is_default of this LogAnalyticsParser. - is default flag + A flag indicating if this is a default parser. :return: The is_default of this LogAnalyticsParser. @@ -503,7 +521,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this LogAnalyticsParser. - is default flag + A flag indicating if this is a default parser. :param is_default: The is_default of this LogAnalyticsParser. @@ -515,7 +533,7 @@ def is_default(self, is_default): def is_single_line_content(self): """ Gets the is_single_line_content of this LogAnalyticsParser. - is single line content + A flag indicating if this is a single line content parser. :return: The is_single_line_content of this LogAnalyticsParser. @@ -527,7 +545,7 @@ def is_single_line_content(self): def is_single_line_content(self, is_single_line_content): """ Sets the is_single_line_content of this LogAnalyticsParser. - is single line content + A flag indicating if this is a single line content parser. :param is_single_line_content: The is_single_line_content of this LogAnalyticsParser. @@ -539,7 +557,8 @@ def is_single_line_content(self, is_single_line_content): def is_system(self): """ Gets the is_system of this LogAnalyticsParser. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsParser. @@ -551,7 +570,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsParser. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsParser. @@ -563,7 +583,7 @@ def is_system(self, is_system): def language(self): """ Gets the language of this LogAnalyticsParser. - language + The language. :return: The language of this LogAnalyticsParser. @@ -575,7 +595,7 @@ def language(self): def language(self, language): """ Sets the language of this LogAnalyticsParser. - language + The language. :param language: The language of this LogAnalyticsParser. @@ -587,7 +607,7 @@ def language(self, language): def time_updated(self): """ Gets the time_updated of this LogAnalyticsParser. - last updated date + The last updated date. :return: The time_updated of this LogAnalyticsParser. @@ -599,7 +619,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsParser. - last updated date + The last updated date. :param time_updated: The time_updated of this LogAnalyticsParser. @@ -611,7 +631,7 @@ def time_updated(self, time_updated): def log_type_test_request_version(self): """ Gets the log_type_test_request_version of this LogAnalyticsParser. - log type test request version + The log type test request . :return: The log_type_test_request_version of this LogAnalyticsParser. @@ -623,7 +643,7 @@ def log_type_test_request_version(self): def log_type_test_request_version(self, log_type_test_request_version): """ Sets the log_type_test_request_version of this LogAnalyticsParser. - log type test request version + The log type test request . :param log_type_test_request_version: The log_type_test_request_version of this LogAnalyticsParser. @@ -635,7 +655,7 @@ def log_type_test_request_version(self, log_type_test_request_version): def mapped_parsers(self): """ Gets the mapped_parsers of this LogAnalyticsParser. - mapped parser list + The mapped parser list. :return: The mapped_parsers of this LogAnalyticsParser. @@ -647,7 +667,7 @@ def mapped_parsers(self): def mapped_parsers(self, mapped_parsers): """ Sets the mapped_parsers of this LogAnalyticsParser. - mapped parser list + The mapped parser list. :param mapped_parsers: The mapped_parsers of this LogAnalyticsParser. @@ -659,7 +679,7 @@ def mapped_parsers(self, mapped_parsers): def parser_ignoreline_characters(self): """ Gets the parser_ignoreline_characters of this LogAnalyticsParser. - parser ignore line characters + The line characters for the parser to ignore. :return: The parser_ignoreline_characters of this LogAnalyticsParser. @@ -671,7 +691,7 @@ def parser_ignoreline_characters(self): def parser_ignoreline_characters(self, parser_ignoreline_characters): """ Sets the parser_ignoreline_characters of this LogAnalyticsParser. - parser ignore line characters + The line characters for the parser to ignore. :param parser_ignoreline_characters: The parser_ignoreline_characters of this LogAnalyticsParser. @@ -683,7 +703,7 @@ def parser_ignoreline_characters(self, parser_ignoreline_characters): def is_hidden(self): """ Gets the is_hidden of this LogAnalyticsParser. - is hidden flag + A flag indicating if the parser is hidden or not. :return: The is_hidden of this LogAnalyticsParser. @@ -695,7 +715,7 @@ def is_hidden(self): def is_hidden(self, is_hidden): """ Sets the is_hidden of this LogAnalyticsParser. - is hidden flag + A flag indicating if the parser is hidden or not. :param is_hidden: The is_hidden of this LogAnalyticsParser. @@ -707,7 +727,7 @@ def is_hidden(self, is_hidden): def parser_sequence(self): """ Gets the parser_sequence of this LogAnalyticsParser. - sequence + The parser sequence. :return: The parser_sequence of this LogAnalyticsParser. @@ -719,7 +739,7 @@ def parser_sequence(self): def parser_sequence(self, parser_sequence): """ Sets the parser_sequence of this LogAnalyticsParser. - sequence + The parser sequence. :param parser_sequence: The parser_sequence of this LogAnalyticsParser. @@ -731,7 +751,7 @@ def parser_sequence(self, parser_sequence): def parser_timezone(self): """ Gets the parser_timezone of this LogAnalyticsParser. - time zone + The time zone. :return: The parser_timezone of this LogAnalyticsParser. @@ -743,7 +763,7 @@ def parser_timezone(self): def parser_timezone(self, parser_timezone): """ Sets the parser_timezone of this LogAnalyticsParser. - time zone + The time zone. :param parser_timezone: The parser_timezone of this LogAnalyticsParser. @@ -775,7 +795,7 @@ def parser_filter(self, parser_filter): def is_parser_written_once(self): """ Gets the is_parser_written_once of this LogAnalyticsParser. - write once + A flag indicating whther or not the parser is write once. :return: The is_parser_written_once of this LogAnalyticsParser. @@ -787,7 +807,7 @@ def is_parser_written_once(self): def is_parser_written_once(self, is_parser_written_once): """ Sets the is_parser_written_once of this LogAnalyticsParser. - write once + A flag indicating whther or not the parser is write once. :param is_parser_written_once: The is_parser_written_once of this LogAnalyticsParser. @@ -799,7 +819,7 @@ def is_parser_written_once(self, is_parser_written_once): def parser_functions(self): """ Gets the parser_functions of this LogAnalyticsParser. - plugin instance list + The parser function list. :return: The parser_functions of this LogAnalyticsParser. @@ -811,7 +831,7 @@ def parser_functions(self): def parser_functions(self, parser_functions): """ Sets the parser_functions of this LogAnalyticsParser. - plugin instance list + The parser function list. :param parser_functions: The parser_functions of this LogAnalyticsParser. @@ -823,7 +843,7 @@ def parser_functions(self, parser_functions): def sources_count(self): """ Gets the sources_count of this LogAnalyticsParser. - sources using this parser + The number of sources using this parser :return: The sources_count of this LogAnalyticsParser. @@ -835,7 +855,7 @@ def sources_count(self): def sources_count(self, sources_count): """ Sets the sources_count of this LogAnalyticsParser. - sources using this parser + The number of sources using this parser :param sources_count: The sources_count of this LogAnalyticsParser. @@ -847,7 +867,7 @@ def sources_count(self, sources_count): def sources(self): """ Gets the sources of this LogAnalyticsParser. - sources using list + The list of sources using this parser. :return: The sources of this LogAnalyticsParser. @@ -859,7 +879,7 @@ def sources(self): def sources(self, sources): """ Sets the sources of this LogAnalyticsParser. - sources using list + The list of sources using this parser. :param sources: The sources of this LogAnalyticsParser. @@ -871,7 +891,7 @@ def sources(self, sources): def should_tokenize_original_text(self): """ Gets the should_tokenize_original_text of this LogAnalyticsParser. - tokenize original text + A flag indicating whether or not to tokenize the original text. :return: The should_tokenize_original_text of this LogAnalyticsParser. @@ -883,7 +903,7 @@ def should_tokenize_original_text(self): def should_tokenize_original_text(self, should_tokenize_original_text): """ Sets the should_tokenize_original_text of this LogAnalyticsParser. - tokenize original text + A flag indicating whether or not to tokenize the original text. :param should_tokenize_original_text: The should_tokenize_original_text of this LogAnalyticsParser. @@ -891,13 +911,61 @@ def should_tokenize_original_text(self, should_tokenize_original_text): """ self._should_tokenize_original_text = should_tokenize_original_text + @property + def field_delimiter(self): + """ + Gets the field_delimiter of this LogAnalyticsParser. + The parser field delimiter. + + + :return: The field_delimiter of this LogAnalyticsParser. + :rtype: str + """ + return self._field_delimiter + + @field_delimiter.setter + def field_delimiter(self, field_delimiter): + """ + Sets the field_delimiter of this LogAnalyticsParser. + The parser field delimiter. + + + :param field_delimiter: The field_delimiter of this LogAnalyticsParser. + :type: str + """ + self._field_delimiter = field_delimiter + + @property + def field_qualifier(self): + """ + Gets the field_qualifier of this LogAnalyticsParser. + The parser field qualifier. + + + :return: The field_qualifier of this LogAnalyticsParser. + :rtype: str + """ + return self._field_qualifier + + @field_qualifier.setter + def field_qualifier(self, field_qualifier): + """ + Sets the field_qualifier of this LogAnalyticsParser. + The parser field qualifier. + + + :param field_qualifier: The field_qualifier of this LogAnalyticsParser. + :type: str + """ + self._field_qualifier = field_qualifier + @property def type(self): """ Gets the type of this LogAnalyticsParser. - type + The parser type. Default value is REGEX. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -910,13 +978,13 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsParser. - type + The parser type. Default value is REGEX. :param type: The type of this LogAnalyticsParser. :type: str """ - allowed_values = ["XML", "JSON", "REGEX", "ODL"] + allowed_values = ["XML", "JSON", "REGEX", "ODL", "DELIMITED"] if not value_allowed_none_or_none_sentinel(type, allowed_values): type = 'UNKNOWN_ENUM_VALUE' self._type = type @@ -925,7 +993,7 @@ def type(self, type): def is_user_deleted(self): """ Gets the is_user_deleted of this LogAnalyticsParser. - user deleted flag + A flag indicating whether or not the parser has been deleted. :return: The is_user_deleted of this LogAnalyticsParser. @@ -937,7 +1005,7 @@ def is_user_deleted(self): def is_user_deleted(self, is_user_deleted): """ Sets the is_user_deleted of this LogAnalyticsParser. - user deleted flag + A flag indicating whether or not the parser has been deleted. :param is_user_deleted: The is_user_deleted of this LogAnalyticsParser. diff --git a/src/oci/log_analytics/models/log_analytics_parser_collection.py b/src/oci/log_analytics/models/log_analytics_parser_collection.py index 1533b21f66..ead02016fa 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_collection.py +++ b/src/oci/log_analytics/models/log_analytics_parser_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsParserCollection. - list of parsers + An array of parsers. :return: The items of this LogAnalyticsParserCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsParserCollection. - list of parsers + An array of parsers. :param items: The items of this LogAnalyticsParserCollection. diff --git a/src/oci/log_analytics/models/log_analytics_parser_field.py b/src/oci/log_analytics/models/log_analytics_parser_field.py index 87e1e67e31..0691982e30 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_field.py +++ b/src/oci/log_analytics/models/log_analytics_parser_field.py @@ -120,7 +120,7 @@ def field(self, field): def parser_field_id(self): """ Gets the parser_field_id of this LogAnalyticsParserField. - parser field map Id + The parser field unique identifier. :return: The parser_field_id of this LogAnalyticsParserField. @@ -132,7 +132,7 @@ def parser_field_id(self): def parser_field_id(self, parser_field_id): """ Sets the parser_field_id of this LogAnalyticsParserField. - parser field map Id + The parser field unique identifier. :param parser_field_id: The parser_field_id of this LogAnalyticsParserField. @@ -144,7 +144,7 @@ def parser_field_id(self, parser_field_id): def parser_field_expression(self): """ Gets the parser_field_expression of this LogAnalyticsParserField. - field expression + the parser field expression. :return: The parser_field_expression of this LogAnalyticsParserField. @@ -156,7 +156,7 @@ def parser_field_expression(self): def parser_field_expression(self, parser_field_expression): """ Sets the parser_field_expression of this LogAnalyticsParserField. - field expression + the parser field expression. :param parser_field_expression: The parser_field_expression of this LogAnalyticsParserField. @@ -168,7 +168,7 @@ def parser_field_expression(self, parser_field_expression): def parser_field_name(self): """ Gets the parser_field_name of this LogAnalyticsParserField. - field internal name + The parser field internal name. :return: The parser_field_name of this LogAnalyticsParserField. @@ -180,7 +180,7 @@ def parser_field_name(self): def parser_field_name(self, parser_field_name): """ Sets the parser_field_name of this LogAnalyticsParserField. - field internal name + The parser field internal name. :param parser_field_name: The parser_field_name of this LogAnalyticsParserField. @@ -192,7 +192,7 @@ def parser_field_name(self, parser_field_name): def storage_field_name(self): """ Gets the storage_field_name of this LogAnalyticsParserField. - internal name + The storage field name. :return: The storage_field_name of this LogAnalyticsParserField. @@ -204,7 +204,7 @@ def storage_field_name(self): def storage_field_name(self, storage_field_name): """ Sets the storage_field_name of this LogAnalyticsParserField. - internal name + The storage field name. :param storage_field_name: The storage_field_name of this LogAnalyticsParserField. @@ -216,7 +216,7 @@ def storage_field_name(self, storage_field_name): def parser_field_integrator_name(self): """ Gets the parser_field_integrator_name of this LogAnalyticsParserField. - integrator name + The integrator name. :return: The parser_field_integrator_name of this LogAnalyticsParserField. @@ -228,7 +228,7 @@ def parser_field_integrator_name(self): def parser_field_integrator_name(self, parser_field_integrator_name): """ Sets the parser_field_integrator_name of this LogAnalyticsParserField. - integrator name + The integrator name. :param parser_field_integrator_name: The parser_field_integrator_name of this LogAnalyticsParserField. @@ -240,7 +240,7 @@ def parser_field_integrator_name(self, parser_field_integrator_name): def parser_name(self): """ Gets the parser_name of this LogAnalyticsParserField. - parser internal name + The parser internal name. :return: The parser_name of this LogAnalyticsParserField. @@ -252,7 +252,7 @@ def parser_name(self): def parser_name(self, parser_name): """ Sets the parser_name of this LogAnalyticsParserField. - parser internal name + The parser internal name. :param parser_name: The parser_name of this LogAnalyticsParserField. @@ -264,7 +264,7 @@ def parser_name(self, parser_name): def parser_field_sequence(self): """ Gets the parser_field_sequence of this LogAnalyticsParserField. - sequence + The parser field sequence. :return: The parser_field_sequence of this LogAnalyticsParserField. @@ -276,7 +276,7 @@ def parser_field_sequence(self): def parser_field_sequence(self, parser_field_sequence): """ Sets the parser_field_sequence of this LogAnalyticsParserField. - sequence + The parser field sequence. :param parser_field_sequence: The parser_field_sequence of this LogAnalyticsParserField. @@ -308,7 +308,7 @@ def parser(self, parser): def structured_column_info(self): """ Gets the structured_column_info of this LogAnalyticsParserField. - structured column information + The structured column information. :return: The structured_column_info of this LogAnalyticsParserField. @@ -320,7 +320,7 @@ def structured_column_info(self): def structured_column_info(self, structured_column_info): """ Sets the structured_column_info of this LogAnalyticsParserField. - structured column information + The structured column information. :param structured_column_info: The structured_column_info of this LogAnalyticsParserField. diff --git a/src/oci/log_analytics/models/log_analytics_parser_filter.py b/src/oci/log_analytics/models/log_analytics_parser_filter.py index 03f39316ad..1e13ed19e8 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_filter.py +++ b/src/oci/log_analytics/models/log_analytics_parser_filter.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def id(self): """ Gets the id of this LogAnalyticsParserFilter. - id + The parser filter unique identifier. :return: The id of this LogAnalyticsParserFilter. @@ -91,7 +91,7 @@ def id(self): def id(self, id): """ Sets the id of this LogAnalyticsParserFilter. - id + The parser filter unique identifier. :param id: The id of this LogAnalyticsParserFilter. @@ -123,7 +123,7 @@ def parser(self, parser): def agent_version(self): """ Gets the agent_version of this LogAnalyticsParserFilter. - agent version + The agent version. :return: The agent_version of this LogAnalyticsParserFilter. @@ -135,7 +135,7 @@ def agent_version(self): def agent_version(self, agent_version): """ Sets the agent_version of this LogAnalyticsParserFilter. - agent version + The agent version. :param agent_version: The agent_version of this LogAnalyticsParserFilter. @@ -147,7 +147,7 @@ def agent_version(self, agent_version): def is_in_use(self): """ Gets the is_in_use of this LogAnalyticsParserFilter. - is in use flag + A flag idicating whether or not hte filter is currently being used. :return: The is_in_use of this LogAnalyticsParserFilter. @@ -159,7 +159,7 @@ def is_in_use(self): def is_in_use(self, is_in_use): """ Sets the is_in_use of this LogAnalyticsParserFilter. - is in use flag + A flag idicating whether or not hte filter is currently being used. :param is_in_use: The is_in_use of this LogAnalyticsParserFilter. @@ -171,7 +171,7 @@ def is_in_use(self, is_in_use): def operating_system(self): """ Gets the operating_system of this LogAnalyticsParserFilter. - operating system + The operating system. :return: The operating_system of this LogAnalyticsParserFilter. @@ -183,7 +183,7 @@ def operating_system(self): def operating_system(self, operating_system): """ Sets the operating_system of this LogAnalyticsParserFilter. - operating system + The operating system. :param operating_system: The operating_system of this LogAnalyticsParserFilter. @@ -195,7 +195,7 @@ def operating_system(self, operating_system): def parser_id(self): """ Gets the parser_id of this LogAnalyticsParserFilter. - parser Id + The parser unique identifier. :return: The parser_id of this LogAnalyticsParserFilter. @@ -207,7 +207,7 @@ def parser_id(self): def parser_id(self, parser_id): """ Sets the parser_id of this LogAnalyticsParserFilter. - parser Id + The parser unique identifier. :param parser_id: The parser_id of this LogAnalyticsParserFilter. @@ -219,7 +219,7 @@ def parser_id(self, parser_id): def version(self): """ Gets the version of this LogAnalyticsParserFilter. - version + The version. :return: The version of this LogAnalyticsParserFilter. @@ -231,7 +231,7 @@ def version(self): def version(self, version): """ Sets the version of this LogAnalyticsParserFilter. - version + The version. :param version: The version of this LogAnalyticsParserFilter. diff --git a/src/oci/log_analytics/models/log_analytics_parser_function.py b/src/oci/log_analytics/models/log_analytics_parser_function.py index c5a1b44fec..008eef3f92 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_function.py +++ b/src/oci/log_analytics/models/log_analytics_parser_function.py @@ -120,7 +120,7 @@ def parser_meta_plugin(self, parser_meta_plugin): def parser_function_id(self): """ Gets the parser_function_id of this LogAnalyticsParserFunction. - plugin instance Id + The parser function unique identifier. :return: The parser_function_id of this LogAnalyticsParserFunction. @@ -132,7 +132,7 @@ def parser_function_id(self): def parser_function_id(self, parser_function_id): """ Sets the parser_function_id of this LogAnalyticsParserFunction. - plugin instance Id + The parser function unique identifier. :param parser_function_id: The parser_function_id of this LogAnalyticsParserFunction. @@ -144,7 +144,7 @@ def parser_function_id(self, parser_function_id): def parser_function_name(self): """ Gets the parser_function_name of this LogAnalyticsParserFunction. - plugin instance internal name + The parser function internal name. :return: The parser_function_name of this LogAnalyticsParserFunction. @@ -156,7 +156,7 @@ def parser_function_name(self): def parser_function_name(self, parser_function_name): """ Sets the parser_function_name of this LogAnalyticsParserFunction. - plugin instance internal name + The parser function internal name. :param parser_function_name: The parser_function_name of this LogAnalyticsParserFunction. @@ -168,7 +168,7 @@ def parser_function_name(self, parser_function_name): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsParserFunction. - is enabled flag + A flag inidcating whether or not the parser function is enabled. :return: The is_enabled of this LogAnalyticsParserFunction. @@ -180,7 +180,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsParserFunction. - is enabled flag + A flag inidcating whether or not the parser function is enabled. :param is_enabled: The is_enabled of this LogAnalyticsParserFunction. @@ -192,7 +192,8 @@ def is_enabled(self, is_enabled): def is_system(self): """ Gets the is_system of this LogAnalyticsParserFunction. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsParserFunction. @@ -204,7 +205,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsParserFunction. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsParserFunction. @@ -216,7 +218,7 @@ def is_system(self, is_system): def parser_id(self): """ Gets the parser_id of this LogAnalyticsParserFunction. - parser Id + The associated parser unique identifier. :return: The parser_id of this LogAnalyticsParserFunction. @@ -228,7 +230,7 @@ def parser_id(self): def parser_id(self, parser_id): """ Sets the parser_id of this LogAnalyticsParserFunction. - parser Id + The associated parser unique identifier. :param parser_id: The parser_id of this LogAnalyticsParserFunction. @@ -240,7 +242,7 @@ def parser_id(self, parser_id): def parser_name(self): """ Gets the parser_name of this LogAnalyticsParserFunction. - parser internal name + The associated parser internal name. :return: The parser_name of this LogAnalyticsParserFunction. @@ -252,7 +254,7 @@ def parser_name(self): def parser_name(self, parser_name): """ Sets the parser_name of this LogAnalyticsParserFunction. - parser internal name + The associated parser internal name. :param parser_name: The parser_name of this LogAnalyticsParserFunction. @@ -264,7 +266,7 @@ def parser_name(self, parser_name): def parser_meta_plugin_name(self): """ Gets the parser_meta_plugin_name of this LogAnalyticsParserFunction. - plugin type internal name + The plugin internal name. :return: The parser_meta_plugin_name of this LogAnalyticsParserFunction. @@ -276,7 +278,7 @@ def parser_meta_plugin_name(self): def parser_meta_plugin_name(self, parser_meta_plugin_name): """ Sets the parser_meta_plugin_name of this LogAnalyticsParserFunction. - plugin type internal name + The plugin internal name. :param parser_meta_plugin_name: The parser_meta_plugin_name of this LogAnalyticsParserFunction. @@ -288,7 +290,7 @@ def parser_meta_plugin_name(self, parser_meta_plugin_name): def parser_function_priority(self): """ Gets the parser_function_priority of this LogAnalyticsParserFunction. - priority + The parser function priority. :return: The parser_function_priority of this LogAnalyticsParserFunction. @@ -300,7 +302,7 @@ def parser_function_priority(self): def parser_function_priority(self, parser_function_priority): """ Sets the parser_function_priority of this LogAnalyticsParserFunction. - priority + The parser function priority. :param parser_function_priority: The parser_function_priority of this LogAnalyticsParserFunction. @@ -312,7 +314,7 @@ def parser_function_priority(self, parser_function_priority): def parser_function_parameters(self): """ Gets the parser_function_parameters of this LogAnalyticsParserFunction. - parameter map list + The parser function parameter list. :return: The parser_function_parameters of this LogAnalyticsParserFunction. @@ -324,7 +326,7 @@ def parser_function_parameters(self): def parser_function_parameters(self, parser_function_parameters): """ Sets the parser_function_parameters of this LogAnalyticsParserFunction. - parameter map list + The parser function parameter list. :param parser_function_parameters: The parser_function_parameters of this LogAnalyticsParserFunction. diff --git a/src/oci/log_analytics/models/log_analytics_parser_function_collection.py b/src/oci/log_analytics/models/log_analytics_parser_function_collection.py index 89dcee7988..354584459b 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_function_collection.py +++ b/src/oci/log_analytics/models/log_analytics_parser_function_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsParserFunctionCollection. - meta pre-process pagination list + An array of parser function. :return: The items of this LogAnalyticsParserFunctionCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsParserFunctionCollection. - meta pre-process pagination list + An array of parser function. :param items: The items of this LogAnalyticsParserFunctionCollection. diff --git a/src/oci/log_analytics/models/log_analytics_parser_function_parameter.py b/src/oci/log_analytics/models/log_analytics_parser_function_parameter.py index 7523790316..67c028ab51 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_function_parameter.py +++ b/src/oci/log_analytics/models/log_analytics_parser_function_parameter.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def parser_function_id(self): """ Gets the parser_function_id of this LogAnalyticsParserFunctionParameter. - plugin Id + The parser function unique identifier. :return: The parser_function_id of this LogAnalyticsParserFunctionParameter. @@ -91,7 +91,7 @@ def parser_function_id(self): def parser_function_id(self, parser_function_id): """ Sets the parser_function_id of this LogAnalyticsParserFunctionParameter. - plugin Id + The parser function unique identifier. :param parser_function_id: The parser_function_id of this LogAnalyticsParserFunctionParameter. @@ -103,7 +103,7 @@ def parser_function_id(self, parser_function_id): def parser_function_parameter_name(self): """ Gets the parser_function_parameter_name of this LogAnalyticsParserFunctionParameter. - internal name + The internal name :return: The parser_function_parameter_name of this LogAnalyticsParserFunctionParameter. @@ -115,7 +115,7 @@ def parser_function_parameter_name(self): def parser_function_parameter_name(self, parser_function_parameter_name): """ Sets the parser_function_parameter_name of this LogAnalyticsParserFunctionParameter. - internal name + The internal name :param parser_function_parameter_name: The parser_function_parameter_name of this LogAnalyticsParserFunctionParameter. @@ -127,7 +127,7 @@ def parser_function_parameter_name(self, parser_function_parameter_name): def parser_function_parameter_id(self): """ Gets the parser_function_parameter_id of this LogAnalyticsParserFunctionParameter. - plugin instance Id + The parameter unique identifier. :return: The parser_function_parameter_id of this LogAnalyticsParserFunctionParameter. @@ -139,7 +139,7 @@ def parser_function_parameter_id(self): def parser_function_parameter_id(self, parser_function_parameter_id): """ Sets the parser_function_parameter_id of this LogAnalyticsParserFunctionParameter. - plugin instance Id + The parameter unique identifier. :param parser_function_parameter_id: The parser_function_parameter_id of this LogAnalyticsParserFunctionParameter. @@ -151,7 +151,7 @@ def parser_function_parameter_id(self, parser_function_parameter_id): def parser_meta_plugin_parameter_name(self): """ Gets the parser_meta_plugin_parameter_name of this LogAnalyticsParserFunctionParameter. - parameter internal name + The parameter internal name. :return: The parser_meta_plugin_parameter_name of this LogAnalyticsParserFunctionParameter. @@ -163,7 +163,7 @@ def parser_meta_plugin_parameter_name(self): def parser_meta_plugin_parameter_name(self, parser_meta_plugin_parameter_name): """ Sets the parser_meta_plugin_parameter_name of this LogAnalyticsParserFunctionParameter. - parameter internal name + The parameter internal name. :param parser_meta_plugin_parameter_name: The parser_meta_plugin_parameter_name of this LogAnalyticsParserFunctionParameter. @@ -175,7 +175,7 @@ def parser_meta_plugin_parameter_name(self, parser_meta_plugin_parameter_name): def parser_meta_plugin_parameter_value(self): """ Gets the parser_meta_plugin_parameter_value of this LogAnalyticsParserFunctionParameter. - parameter value + The parameter value. :return: The parser_meta_plugin_parameter_value of this LogAnalyticsParserFunctionParameter. @@ -187,7 +187,7 @@ def parser_meta_plugin_parameter_value(self): def parser_meta_plugin_parameter_value(self, parser_meta_plugin_parameter_value): """ Sets the parser_meta_plugin_parameter_value of this LogAnalyticsParserFunctionParameter. - parameter value + The parameter value. :param parser_meta_plugin_parameter_value: The parser_meta_plugin_parameter_value of this LogAnalyticsParserFunctionParameter. @@ -199,7 +199,7 @@ def parser_meta_plugin_parameter_value(self, parser_meta_plugin_parameter_value) def parser_name(self): """ Gets the parser_name of this LogAnalyticsParserFunctionParameter. - parser internal name + The parser internal name. :return: The parser_name of this LogAnalyticsParserFunctionParameter. @@ -211,7 +211,7 @@ def parser_name(self): def parser_name(self, parser_name): """ Sets the parser_name of this LogAnalyticsParserFunctionParameter. - parser internal name + The parser internal name. :param parser_name: The parser_name of this LogAnalyticsParserFunctionParameter. diff --git a/src/oci/log_analytics/models/log_analytics_parser_meta_plugin.py b/src/oci/log_analytics/models/log_analytics_parser_meta_plugin.py index 2a3de9f074..7cdc266a6e 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_meta_plugin.py +++ b/src/oci/log_analytics/models/log_analytics_parser_meta_plugin.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def meta_plugin_parameters(self): """ Gets the meta_plugin_parameters of this LogAnalyticsParserMetaPlugin. - parameter list + An array of plugin parameters. :return: The meta_plugin_parameters of this LogAnalyticsParserMetaPlugin. @@ -70,7 +70,7 @@ def meta_plugin_parameters(self): def meta_plugin_parameters(self, meta_plugin_parameters): """ Sets the meta_plugin_parameters of this LogAnalyticsParserMetaPlugin. - parameter list + An array of plugin parameters. :param meta_plugin_parameters: The meta_plugin_parameters of this LogAnalyticsParserMetaPlugin. @@ -82,7 +82,7 @@ def meta_plugin_parameters(self, meta_plugin_parameters): def description(self): """ Gets the description of this LogAnalyticsParserMetaPlugin. - plugin description + The plugin description. :return: The description of this LogAnalyticsParserMetaPlugin. @@ -94,7 +94,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsParserMetaPlugin. - plugin description + The plugin description. :param description: The description of this LogAnalyticsParserMetaPlugin. @@ -106,7 +106,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsParserMetaPlugin. - plugin display name + The plugin display name. :return: The display_name of this LogAnalyticsParserMetaPlugin. @@ -118,7 +118,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsParserMetaPlugin. - plugin display name + The plugin display name. :param display_name: The display_name of this LogAnalyticsParserMetaPlugin. @@ -130,7 +130,7 @@ def display_name(self, display_name): def name(self): """ Gets the name of this LogAnalyticsParserMetaPlugin. - plugin internal name + The plugin internal name. :return: The name of this LogAnalyticsParserMetaPlugin. @@ -142,7 +142,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsParserMetaPlugin. - plugin internal name + The plugin internal name. :param name: The name of this LogAnalyticsParserMetaPlugin. diff --git a/src/oci/log_analytics/models/log_analytics_parser_meta_plugin_parameter.py b/src/oci/log_analytics/models/log_analytics_parser_meta_plugin_parameter.py index 019d12329a..9f4ca71f9e 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_meta_plugin_parameter.py +++ b/src/oci/log_analytics/models/log_analytics_parser_meta_plugin_parameter.py @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def description(self): """ Gets the description of this LogAnalyticsParserMetaPluginParameter. - parameter description + The parameter description. :return: The description of this LogAnalyticsParserMetaPluginParameter. @@ -84,7 +84,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsParserMetaPluginParameter. - parameter description + The parameter description. :param description: The description of this LogAnalyticsParserMetaPluginParameter. @@ -96,7 +96,7 @@ def description(self, description): def name(self): """ Gets the name of this LogAnalyticsParserMetaPluginParameter. - parameter internal name + The parameter internal name. :return: The name of this LogAnalyticsParserMetaPluginParameter. @@ -108,7 +108,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsParserMetaPluginParameter. - parameter internal name + The parameter internal name. :param name: The name of this LogAnalyticsParserMetaPluginParameter. @@ -120,7 +120,7 @@ def name(self, name): def is_mandatory(self): """ Gets the is_mandatory of this LogAnalyticsParserMetaPluginParameter. - is mandatory flag + A flag indicating whether or not the parameter is mandatory. :return: The is_mandatory of this LogAnalyticsParserMetaPluginParameter. @@ -132,7 +132,7 @@ def is_mandatory(self): def is_mandatory(self, is_mandatory): """ Sets the is_mandatory of this LogAnalyticsParserMetaPluginParameter. - is mandatory flag + A flag indicating whether or not the parameter is mandatory. :param is_mandatory: The is_mandatory of this LogAnalyticsParserMetaPluginParameter. @@ -144,7 +144,7 @@ def is_mandatory(self, is_mandatory): def is_repeatable(self): """ Gets the is_repeatable of this LogAnalyticsParserMetaPluginParameter. - is repeatable flag + A flag indicating whether or not the parameter is repeatable. :return: The is_repeatable of this LogAnalyticsParserMetaPluginParameter. @@ -156,7 +156,7 @@ def is_repeatable(self): def is_repeatable(self, is_repeatable): """ Sets the is_repeatable of this LogAnalyticsParserMetaPluginParameter. - is repeatable flag + A flag indicating whether or not the parameter is repeatable. :param is_repeatable: The is_repeatable of this LogAnalyticsParserMetaPluginParameter. @@ -168,7 +168,7 @@ def is_repeatable(self, is_repeatable): def plugin_name(self): """ Gets the plugin_name of this LogAnalyticsParserMetaPluginParameter. - plugin internal name + The plugin internal name. :return: The plugin_name of this LogAnalyticsParserMetaPluginParameter. @@ -180,7 +180,7 @@ def plugin_name(self): def plugin_name(self, plugin_name): """ Sets the plugin_name of this LogAnalyticsParserMetaPluginParameter. - plugin internal name + The plugin internal name. :param plugin_name: The plugin_name of this LogAnalyticsParserMetaPluginParameter. @@ -192,7 +192,7 @@ def plugin_name(self, plugin_name): def type(self): """ Gets the type of this LogAnalyticsParserMetaPluginParameter. - parameter type + The parameter type. :return: The type of this LogAnalyticsParserMetaPluginParameter. @@ -204,7 +204,7 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsParserMetaPluginParameter. - parameter type + The parameter type. :param type: The type of this LogAnalyticsParserMetaPluginParameter. diff --git a/src/oci/log_analytics/models/log_analytics_parser_summary.py b/src/oci/log_analytics/models/log_analytics_parser_summary.py index 7c7651ffb7..5ce5f4cb6a 100644 --- a/src/oci/log_analytics/models/log_analytics_parser_summary.py +++ b/src/oci/log_analytics/models/log_analytics_parser_summary.py @@ -29,6 +29,10 @@ class LogAnalyticsParserSummary(object): #: This constant has a value of "ODL" TYPE_ODL = "ODL" + #: A constant which can be used with the type property of a LogAnalyticsParserSummary. + #: This constant has a value of "DELIMITED" + TYPE_DELIMITED = "DELIMITED" + def __init__(self, **kwargs): """ Initializes a new LogAnalyticsParserSummary object with values from keyword arguments. @@ -142,9 +146,17 @@ def __init__(self, **kwargs): The value to assign to the should_tokenize_original_text property of this LogAnalyticsParserSummary. :type should_tokenize_original_text: bool + :param field_delimiter: + The value to assign to the field_delimiter property of this LogAnalyticsParserSummary. + :type field_delimiter: str + + :param field_qualifier: + The value to assign to the field_qualifier property of this LogAnalyticsParserSummary. + :type field_qualifier: str + :param type: The value to assign to the type property of this LogAnalyticsParserSummary. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type type: str @@ -181,6 +193,8 @@ def __init__(self, **kwargs): 'sources_count': 'int', 'sources': 'list[LogAnalyticsSource]', 'should_tokenize_original_text': 'bool', + 'field_delimiter': 'str', + 'field_qualifier': 'str', 'type': 'str', 'is_user_deleted': 'bool' } @@ -213,6 +227,8 @@ def __init__(self, **kwargs): 'sources_count': 'sourcesCount', 'sources': 'sources', 'should_tokenize_original_text': 'shouldTokenizeOriginalText', + 'field_delimiter': 'fieldDelimiter', + 'field_qualifier': 'fieldQualifier', 'type': 'type', 'is_user_deleted': 'isUserDeleted' } @@ -244,6 +260,8 @@ def __init__(self, **kwargs): self._sources_count = None self._sources = None self._should_tokenize_original_text = None + self._field_delimiter = None + self._field_qualifier = None self._type = None self._is_user_deleted = None @@ -251,7 +269,7 @@ def __init__(self, **kwargs): def content(self): """ Gets the content of this LogAnalyticsParserSummary. - content + The content. :return: The content of this LogAnalyticsParserSummary. @@ -263,7 +281,7 @@ def content(self): def content(self, content): """ Sets the content of this LogAnalyticsParserSummary. - content + The content. :param content: The content of this LogAnalyticsParserSummary. @@ -275,7 +293,7 @@ def content(self, content): def description(self): """ Gets the description of this LogAnalyticsParserSummary. - description + The parser description. :return: The description of this LogAnalyticsParserSummary. @@ -287,7 +305,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsParserSummary. - description + The parser description. :param description: The description of this LogAnalyticsParserSummary. @@ -299,7 +317,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsParserSummary. - display name + The parser display name. :return: The display_name of this LogAnalyticsParserSummary. @@ -311,7 +329,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsParserSummary. - display name + The parser display name. :param display_name: The display_name of this LogAnalyticsParserSummary. @@ -323,7 +341,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsParserSummary. - edit version + The parser edit version. :return: The edit_version of this LogAnalyticsParserSummary. @@ -335,7 +353,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsParserSummary. - edit version + The parser edit version. :param edit_version: The edit_version of this LogAnalyticsParserSummary. @@ -347,7 +365,7 @@ def edit_version(self, edit_version): def encoding(self): """ Gets the encoding of this LogAnalyticsParserSummary. - encoding + The encoding. :return: The encoding of this LogAnalyticsParserSummary. @@ -359,7 +377,7 @@ def encoding(self): def encoding(self, encoding): """ Sets the encoding of this LogAnalyticsParserSummary. - encoding + The encoding. :param encoding: The encoding of this LogAnalyticsParserSummary. @@ -371,7 +389,7 @@ def encoding(self, encoding): def example_content(self): """ Gets the example_content of this LogAnalyticsParserSummary. - example content + The example content. :return: The example_content of this LogAnalyticsParserSummary. @@ -383,7 +401,7 @@ def example_content(self): def example_content(self, example_content): """ Sets the example_content of this LogAnalyticsParserSummary. - example content + The example content. :param example_content: The example_content of this LogAnalyticsParserSummary. @@ -395,7 +413,7 @@ def example_content(self, example_content): def field_maps(self): """ Gets the field_maps of this LogAnalyticsParserSummary. - fields Maps + The parser fields. :return: The field_maps of this LogAnalyticsParserSummary. @@ -407,7 +425,7 @@ def field_maps(self): def field_maps(self, field_maps): """ Sets the field_maps of this LogAnalyticsParserSummary. - fields Maps + The parser fields. :param field_maps: The field_maps of this LogAnalyticsParserSummary. @@ -419,7 +437,7 @@ def field_maps(self, field_maps): def footer_content(self): """ Gets the footer_content of this LogAnalyticsParserSummary. - footer regular expression + The footer regular expression. :return: The footer_content of this LogAnalyticsParserSummary. @@ -431,7 +449,7 @@ def footer_content(self): def footer_content(self, footer_content): """ Sets the footer_content of this LogAnalyticsParserSummary. - footer regular expression + The footer regular expression. :param footer_content: The footer_content of this LogAnalyticsParserSummary. @@ -443,7 +461,7 @@ def footer_content(self, footer_content): def header_content(self): """ Gets the header_content of this LogAnalyticsParserSummary. - header content + The header content. :return: The header_content of this LogAnalyticsParserSummary. @@ -455,7 +473,7 @@ def header_content(self): def header_content(self, header_content): """ Sets the header_content of this LogAnalyticsParserSummary. - header content + The header content. :param header_content: The header_content of this LogAnalyticsParserSummary. @@ -467,7 +485,7 @@ def header_content(self, header_content): def name(self): """ Gets the name of this LogAnalyticsParserSummary. - Name + The parser name. :return: The name of this LogAnalyticsParserSummary. @@ -479,7 +497,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsParserSummary. - Name + The parser name. :param name: The name of this LogAnalyticsParserSummary. @@ -491,7 +509,7 @@ def name(self, name): def is_default(self): """ Gets the is_default of this LogAnalyticsParserSummary. - is default flag + A flag indicating if this is a default parser. :return: The is_default of this LogAnalyticsParserSummary. @@ -503,7 +521,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this LogAnalyticsParserSummary. - is default flag + A flag indicating if this is a default parser. :param is_default: The is_default of this LogAnalyticsParserSummary. @@ -515,7 +533,7 @@ def is_default(self, is_default): def is_single_line_content(self): """ Gets the is_single_line_content of this LogAnalyticsParserSummary. - is single line content + A flag indicating if this is a single line content parser. :return: The is_single_line_content of this LogAnalyticsParserSummary. @@ -527,7 +545,7 @@ def is_single_line_content(self): def is_single_line_content(self, is_single_line_content): """ Sets the is_single_line_content of this LogAnalyticsParserSummary. - is single line content + A flag indicating if this is a single line content parser. :param is_single_line_content: The is_single_line_content of this LogAnalyticsParserSummary. @@ -539,7 +557,8 @@ def is_single_line_content(self, is_single_line_content): def is_system(self): """ Gets the is_system of this LogAnalyticsParserSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsParserSummary. @@ -551,7 +570,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsParserSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsParserSummary. @@ -563,7 +583,7 @@ def is_system(self, is_system): def language(self): """ Gets the language of this LogAnalyticsParserSummary. - language + The language. :return: The language of this LogAnalyticsParserSummary. @@ -575,7 +595,7 @@ def language(self): def language(self, language): """ Sets the language of this LogAnalyticsParserSummary. - language + The language. :param language: The language of this LogAnalyticsParserSummary. @@ -587,7 +607,7 @@ def language(self, language): def time_updated(self): """ Gets the time_updated of this LogAnalyticsParserSummary. - last updated date + The last updated date. :return: The time_updated of this LogAnalyticsParserSummary. @@ -599,7 +619,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsParserSummary. - last updated date + The last updated date. :param time_updated: The time_updated of this LogAnalyticsParserSummary. @@ -611,7 +631,7 @@ def time_updated(self, time_updated): def log_type_test_request_version(self): """ Gets the log_type_test_request_version of this LogAnalyticsParserSummary. - log type test request version + The log type test request version. :return: The log_type_test_request_version of this LogAnalyticsParserSummary. @@ -623,7 +643,7 @@ def log_type_test_request_version(self): def log_type_test_request_version(self, log_type_test_request_version): """ Sets the log_type_test_request_version of this LogAnalyticsParserSummary. - log type test request version + The log type test request version. :param log_type_test_request_version: The log_type_test_request_version of this LogAnalyticsParserSummary. @@ -635,7 +655,7 @@ def log_type_test_request_version(self, log_type_test_request_version): def mapped_parsers(self): """ Gets the mapped_parsers of this LogAnalyticsParserSummary. - mapped parser list + The mapped parser list. :return: The mapped_parsers of this LogAnalyticsParserSummary. @@ -647,7 +667,7 @@ def mapped_parsers(self): def mapped_parsers(self, mapped_parsers): """ Sets the mapped_parsers of this LogAnalyticsParserSummary. - mapped parser list + The mapped parser list. :param mapped_parsers: The mapped_parsers of this LogAnalyticsParserSummary. @@ -659,7 +679,7 @@ def mapped_parsers(self, mapped_parsers): def parser_ignoreline_characters(self): """ Gets the parser_ignoreline_characters of this LogAnalyticsParserSummary. - parser ignore line characters + The line characters for the parser to ignore. :return: The parser_ignoreline_characters of this LogAnalyticsParserSummary. @@ -671,7 +691,7 @@ def parser_ignoreline_characters(self): def parser_ignoreline_characters(self, parser_ignoreline_characters): """ Sets the parser_ignoreline_characters of this LogAnalyticsParserSummary. - parser ignore line characters + The line characters for the parser to ignore. :param parser_ignoreline_characters: The parser_ignoreline_characters of this LogAnalyticsParserSummary. @@ -683,7 +703,7 @@ def parser_ignoreline_characters(self, parser_ignoreline_characters): def is_hidden(self): """ Gets the is_hidden of this LogAnalyticsParserSummary. - is hidden flag + A flag indicating if the parser is hidden or not. :return: The is_hidden of this LogAnalyticsParserSummary. @@ -695,7 +715,7 @@ def is_hidden(self): def is_hidden(self, is_hidden): """ Sets the is_hidden of this LogAnalyticsParserSummary. - is hidden flag + A flag indicating if the parser is hidden or not. :param is_hidden: The is_hidden of this LogAnalyticsParserSummary. @@ -707,7 +727,7 @@ def is_hidden(self, is_hidden): def parser_sequence(self): """ Gets the parser_sequence of this LogAnalyticsParserSummary. - sequence + The parser sequence. :return: The parser_sequence of this LogAnalyticsParserSummary. @@ -719,7 +739,7 @@ def parser_sequence(self): def parser_sequence(self, parser_sequence): """ Sets the parser_sequence of this LogAnalyticsParserSummary. - sequence + The parser sequence. :param parser_sequence: The parser_sequence of this LogAnalyticsParserSummary. @@ -731,7 +751,7 @@ def parser_sequence(self, parser_sequence): def parser_timezone(self): """ Gets the parser_timezone of this LogAnalyticsParserSummary. - time zone + The time zone. :return: The parser_timezone of this LogAnalyticsParserSummary. @@ -743,7 +763,7 @@ def parser_timezone(self): def parser_timezone(self, parser_timezone): """ Sets the parser_timezone of this LogAnalyticsParserSummary. - time zone + The time zone. :param parser_timezone: The parser_timezone of this LogAnalyticsParserSummary. @@ -775,7 +795,7 @@ def parser_filter(self, parser_filter): def is_parser_written_once(self): """ Gets the is_parser_written_once of this LogAnalyticsParserSummary. - write once + A flag indicating whther or not the parser is write once. :return: The is_parser_written_once of this LogAnalyticsParserSummary. @@ -787,7 +807,7 @@ def is_parser_written_once(self): def is_parser_written_once(self, is_parser_written_once): """ Sets the is_parser_written_once of this LogAnalyticsParserSummary. - write once + A flag indicating whther or not the parser is write once. :param is_parser_written_once: The is_parser_written_once of this LogAnalyticsParserSummary. @@ -799,7 +819,7 @@ def is_parser_written_once(self, is_parser_written_once): def parser_functions(self): """ Gets the parser_functions of this LogAnalyticsParserSummary. - plugin instance list + The parser function list. :return: The parser_functions of this LogAnalyticsParserSummary. @@ -811,7 +831,7 @@ def parser_functions(self): def parser_functions(self, parser_functions): """ Sets the parser_functions of this LogAnalyticsParserSummary. - plugin instance list + The parser function list. :param parser_functions: The parser_functions of this LogAnalyticsParserSummary. @@ -823,7 +843,7 @@ def parser_functions(self, parser_functions): def sources_count(self): """ Gets the sources_count of this LogAnalyticsParserSummary. - sources using this parser + The number of sources using this parser. :return: The sources_count of this LogAnalyticsParserSummary. @@ -835,7 +855,7 @@ def sources_count(self): def sources_count(self, sources_count): """ Sets the sources_count of this LogAnalyticsParserSummary. - sources using this parser + The number of sources using this parser. :param sources_count: The sources_count of this LogAnalyticsParserSummary. @@ -847,7 +867,7 @@ def sources_count(self, sources_count): def sources(self): """ Gets the sources of this LogAnalyticsParserSummary. - sources using list + The list of sources using this parser. :return: The sources of this LogAnalyticsParserSummary. @@ -859,7 +879,7 @@ def sources(self): def sources(self, sources): """ Sets the sources of this LogAnalyticsParserSummary. - sources using list + The list of sources using this parser. :param sources: The sources of this LogAnalyticsParserSummary. @@ -871,7 +891,7 @@ def sources(self, sources): def should_tokenize_original_text(self): """ Gets the should_tokenize_original_text of this LogAnalyticsParserSummary. - tokenize original text + A flag indicating whether or not to tokenize the original text. :return: The should_tokenize_original_text of this LogAnalyticsParserSummary. @@ -883,7 +903,7 @@ def should_tokenize_original_text(self): def should_tokenize_original_text(self, should_tokenize_original_text): """ Sets the should_tokenize_original_text of this LogAnalyticsParserSummary. - tokenize original text + A flag indicating whether or not to tokenize the original text. :param should_tokenize_original_text: The should_tokenize_original_text of this LogAnalyticsParserSummary. @@ -891,13 +911,61 @@ def should_tokenize_original_text(self, should_tokenize_original_text): """ self._should_tokenize_original_text = should_tokenize_original_text + @property + def field_delimiter(self): + """ + Gets the field_delimiter of this LogAnalyticsParserSummary. + The parser field delimiter. + + + :return: The field_delimiter of this LogAnalyticsParserSummary. + :rtype: str + """ + return self._field_delimiter + + @field_delimiter.setter + def field_delimiter(self, field_delimiter): + """ + Sets the field_delimiter of this LogAnalyticsParserSummary. + The parser field delimiter. + + + :param field_delimiter: The field_delimiter of this LogAnalyticsParserSummary. + :type: str + """ + self._field_delimiter = field_delimiter + + @property + def field_qualifier(self): + """ + Gets the field_qualifier of this LogAnalyticsParserSummary. + The parser field qualifier. + + + :return: The field_qualifier of this LogAnalyticsParserSummary. + :rtype: str + """ + return self._field_qualifier + + @field_qualifier.setter + def field_qualifier(self, field_qualifier): + """ + Sets the field_qualifier of this LogAnalyticsParserSummary. + The parser field qualifier. + + + :param field_qualifier: The field_qualifier of this LogAnalyticsParserSummary. + :type: str + """ + self._field_qualifier = field_qualifier + @property def type(self): """ Gets the type of this LogAnalyticsParserSummary. - type + The parser type. Default value is REGEX. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -910,13 +978,13 @@ def type(self): def type(self, type): """ Sets the type of this LogAnalyticsParserSummary. - type + The parser type. Default value is REGEX. :param type: The type of this LogAnalyticsParserSummary. :type: str """ - allowed_values = ["XML", "JSON", "REGEX", "ODL"] + allowed_values = ["XML", "JSON", "REGEX", "ODL", "DELIMITED"] if not value_allowed_none_or_none_sentinel(type, allowed_values): type = 'UNKNOWN_ENUM_VALUE' self._type = type @@ -925,7 +993,7 @@ def type(self, type): def is_user_deleted(self): """ Gets the is_user_deleted of this LogAnalyticsParserSummary. - user deleted flag + A flag indicating whether or not the parser has been deleted. :return: The is_user_deleted of this LogAnalyticsParserSummary. @@ -937,7 +1005,7 @@ def is_user_deleted(self): def is_user_deleted(self, is_user_deleted): """ Sets the is_user_deleted of this LogAnalyticsParserSummary. - user deleted flag + A flag indicating whether or not the parser has been deleted. :param is_user_deleted: The is_user_deleted of this LogAnalyticsParserSummary. diff --git a/src/oci/log_analytics/models/log_analytics_pattern_filter.py b/src/oci/log_analytics/models/log_analytics_pattern_filter.py index 9565cd850f..aaefbc1513 100644 --- a/src/oci/log_analytics/models/log_analytics_pattern_filter.py +++ b/src/oci/log_analytics/models/log_analytics_pattern_filter.py @@ -106,7 +106,7 @@ def pattern(self, pattern): def agent_version(self): """ Gets the agent_version of this LogAnalyticsPatternFilter. - agent version + The agent version. :return: The agent_version of this LogAnalyticsPatternFilter. @@ -118,7 +118,7 @@ def agent_version(self): def agent_version(self, agent_version): """ Sets the agent_version of this LogAnalyticsPatternFilter. - agent version + The agent version. :param agent_version: The agent_version of this LogAnalyticsPatternFilter. @@ -130,7 +130,8 @@ def agent_version(self, agent_version): def is_in_use(self): """ Gets the is_in_use of this LogAnalyticsPatternFilter. - is in use flag + A flag indicating whether or not the pattern filter is currently + in use. :return: The is_in_use of this LogAnalyticsPatternFilter. @@ -142,7 +143,8 @@ def is_in_use(self): def is_in_use(self, is_in_use): """ Sets the is_in_use of this LogAnalyticsPatternFilter. - is in use flag + A flag indicating whether or not the pattern filter is currently + in use. :param is_in_use: The is_in_use of this LogAnalyticsPatternFilter. @@ -154,7 +156,7 @@ def is_in_use(self, is_in_use): def operating_system(self): """ Gets the operating_system of this LogAnalyticsPatternFilter. - operating system + The operating system. :return: The operating_system of this LogAnalyticsPatternFilter. @@ -166,7 +168,7 @@ def operating_system(self): def operating_system(self, operating_system): """ Sets the operating_system of this LogAnalyticsPatternFilter. - operating system + The operating system. :param operating_system: The operating_system of this LogAnalyticsPatternFilter. @@ -178,7 +180,7 @@ def operating_system(self, operating_system): def pattern_id(self): """ Gets the pattern_id of this LogAnalyticsPatternFilter. - pattern Id + The pattern unique identifier. :return: The pattern_id of this LogAnalyticsPatternFilter. @@ -190,7 +192,7 @@ def pattern_id(self): def pattern_id(self, pattern_id): """ Sets the pattern_id of this LogAnalyticsPatternFilter. - pattern Id + The pattern unique identifier. :param pattern_id: The pattern_id of this LogAnalyticsPatternFilter. @@ -202,7 +204,7 @@ def pattern_id(self, pattern_id): def source_id(self): """ Gets the source_id of this LogAnalyticsPatternFilter. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsPatternFilter. @@ -214,7 +216,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsPatternFilter. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsPatternFilter. @@ -226,7 +228,7 @@ def source_id(self, source_id): def version(self): """ Gets the version of this LogAnalyticsPatternFilter. - version + The pattern filter version. :return: The version of this LogAnalyticsPatternFilter. @@ -238,7 +240,7 @@ def version(self): def version(self, version): """ Sets the version of this LogAnalyticsPatternFilter. - version + The pattern filter version. :param version: The version of this LogAnalyticsPatternFilter. diff --git a/src/oci/log_analytics/models/log_analytics_source.py b/src/oci/log_analytics/models/log_analytics_source.py index 8186647d54..14a6a932d2 100644 --- a/src/oci/log_analytics/models/log_analytics_source.py +++ b/src/oci/log_analytics/models/log_analytics_source.py @@ -282,7 +282,7 @@ def __init__(self, **kwargs): def label_conditions(self): """ Gets the label_conditions of this LogAnalyticsSource. - alert conditions + The label alert conditions. :return: The label_conditions of this LogAnalyticsSource. @@ -294,7 +294,7 @@ def label_conditions(self): def label_conditions(self, label_conditions): """ Sets the label_conditions of this LogAnalyticsSource. - alert conditions + The label alert conditions. :param label_conditions: The label_conditions of this LogAnalyticsSource. @@ -306,7 +306,7 @@ def label_conditions(self, label_conditions): def association_count(self): """ Gets the association_count of this LogAnalyticsSource. - association count + The association count. :return: The association_count of this LogAnalyticsSource. @@ -318,7 +318,7 @@ def association_count(self): def association_count(self, association_count): """ Sets the association_count of this LogAnalyticsSource. - association count + The association count. :param association_count: The association_count of this LogAnalyticsSource. @@ -330,7 +330,7 @@ def association_count(self, association_count): def association_entity(self): """ Gets the association_entity of this LogAnalyticsSource. - association entity + The association entities. :return: The association_entity of this LogAnalyticsSource. @@ -342,7 +342,7 @@ def association_entity(self): def association_entity(self, association_entity): """ Sets the association_entity of this LogAnalyticsSource. - association entity + The association entities. :param association_entity: The association_entity of this LogAnalyticsSource. @@ -354,7 +354,7 @@ def association_entity(self, association_entity): def data_filter_definitions(self): """ Gets the data_filter_definitions of this LogAnalyticsSource. - data filter definitions + The data filter definitions. :return: The data_filter_definitions of this LogAnalyticsSource. @@ -366,7 +366,7 @@ def data_filter_definitions(self): def data_filter_definitions(self, data_filter_definitions): """ Sets the data_filter_definitions of this LogAnalyticsSource. - data filter definitions + The data filter definitions. :param data_filter_definitions: The data_filter_definitions of this LogAnalyticsSource. @@ -378,7 +378,7 @@ def data_filter_definitions(self, data_filter_definitions): def database_credential(self): """ Gets the database_credential of this LogAnalyticsSource. - DB credential + The database credential. :return: The database_credential of this LogAnalyticsSource. @@ -390,7 +390,7 @@ def database_credential(self): def database_credential(self, database_credential): """ Sets the database_credential of this LogAnalyticsSource. - DB credential + The database credential. :param database_credential: The database_credential of this LogAnalyticsSource. @@ -402,7 +402,7 @@ def database_credential(self, database_credential): def extended_field_definitions(self): """ Gets the extended_field_definitions of this LogAnalyticsSource. - extended field definition + The extended field definitions. :return: The extended_field_definitions of this LogAnalyticsSource. @@ -414,7 +414,7 @@ def extended_field_definitions(self): def extended_field_definitions(self, extended_field_definitions): """ Sets the extended_field_definitions of this LogAnalyticsSource. - extended field definition + The extended field definitions. :param extended_field_definitions: The extended_field_definitions of this LogAnalyticsSource. @@ -426,7 +426,7 @@ def extended_field_definitions(self, extended_field_definitions): def is_for_cloud(self): """ Gets the is_for_cloud of this LogAnalyticsSource. - is for cloud flag + A flag indicating whether or not this is a cloud source. :return: The is_for_cloud of this LogAnalyticsSource. @@ -438,7 +438,7 @@ def is_for_cloud(self): def is_for_cloud(self, is_for_cloud): """ Sets the is_for_cloud of this LogAnalyticsSource. - is for cloud flag + A flag indicating whether or not this is a cloud source. :param is_for_cloud: The is_for_cloud of this LogAnalyticsSource. @@ -450,7 +450,7 @@ def is_for_cloud(self, is_for_cloud): def labels(self): """ Gets the labels of this LogAnalyticsSource. - labels + The labels associated with the source. :return: The labels of this LogAnalyticsSource. @@ -462,7 +462,7 @@ def labels(self): def labels(self, labels): """ Sets the labels of this LogAnalyticsSource. - labels + The labels associated with the source. :param labels: The labels of this LogAnalyticsSource. @@ -474,7 +474,7 @@ def labels(self, labels): def metric_definitions(self): """ Gets the metric_definitions of this LogAnalyticsSource. - metric definitions + The metric definitions. :return: The metric_definitions of this LogAnalyticsSource. @@ -486,7 +486,7 @@ def metric_definitions(self): def metric_definitions(self, metric_definitions): """ Sets the metric_definitions of this LogAnalyticsSource. - metric definitions + The metric definitions. :param metric_definitions: The metric_definitions of this LogAnalyticsSource. @@ -498,7 +498,7 @@ def metric_definitions(self, metric_definitions): def metrics(self): """ Gets the metrics of this LogAnalyticsSource. - metric source map + The metric source map. :return: The metrics of this LogAnalyticsSource. @@ -510,7 +510,7 @@ def metrics(self): def metrics(self, metrics): """ Sets the metrics of this LogAnalyticsSource. - metric source map + The metric source map. :param metrics: The metrics of this LogAnalyticsSource. @@ -522,7 +522,7 @@ def metrics(self, metrics): def oob_parsers(self): """ Gets the oob_parsers of this LogAnalyticsSource. - out-of-the-box source parser list + The built in parsers associated with source. :return: The oob_parsers of this LogAnalyticsSource. @@ -534,7 +534,7 @@ def oob_parsers(self): def oob_parsers(self, oob_parsers): """ Sets the oob_parsers of this LogAnalyticsSource. - out-of-the-box source parser list + The built in parsers associated with source. :param oob_parsers: The oob_parsers of this LogAnalyticsSource. @@ -546,7 +546,7 @@ def oob_parsers(self, oob_parsers): def parameters(self): """ Gets the parameters of this LogAnalyticsSource. - parameters + The source parameters. :return: The parameters of this LogAnalyticsSource. @@ -558,7 +558,7 @@ def parameters(self): def parameters(self, parameters): """ Sets the parameters of this LogAnalyticsSource. - parameters + The source parameters. :param parameters: The parameters of this LogAnalyticsSource. @@ -570,7 +570,7 @@ def parameters(self, parameters): def pattern_count(self): """ Gets the pattern_count of this LogAnalyticsSource. - pattern count + The pattern count. :return: The pattern_count of this LogAnalyticsSource. @@ -582,7 +582,7 @@ def pattern_count(self): def pattern_count(self, pattern_count): """ Sets the pattern_count of this LogAnalyticsSource. - pattern count + The pattern count. :param pattern_count: The pattern_count of this LogAnalyticsSource. @@ -594,7 +594,7 @@ def pattern_count(self, pattern_count): def patterns(self): """ Gets the patterns of this LogAnalyticsSource. - patterns + The source patterns. :return: The patterns of this LogAnalyticsSource. @@ -606,7 +606,7 @@ def patterns(self): def patterns(self, patterns): """ Sets the patterns of this LogAnalyticsSource. - patterns + The source patterns. :param patterns: The patterns of this LogAnalyticsSource. @@ -618,7 +618,7 @@ def patterns(self, patterns): def description(self): """ Gets the description of this LogAnalyticsSource. - description + The source description. :return: The description of this LogAnalyticsSource. @@ -630,7 +630,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsSource. - description + The source description. :param description: The description of this LogAnalyticsSource. @@ -642,7 +642,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsSource. - display name + The source display name. :return: The display_name of this LogAnalyticsSource. @@ -654,7 +654,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsSource. - display name + The source display name. :param display_name: The display_name of this LogAnalyticsSource. @@ -666,7 +666,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsSource. - source edit version + The source edit version. :return: The edit_version of this LogAnalyticsSource. @@ -678,7 +678,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsSource. - source edit version + The source edit version. :param edit_version: The edit_version of this LogAnalyticsSource. @@ -690,7 +690,7 @@ def edit_version(self, edit_version): def functions(self): """ Gets the functions of this LogAnalyticsSource. - source functions + The source functions. :return: The functions of this LogAnalyticsSource. @@ -702,7 +702,7 @@ def functions(self): def functions(self, functions): """ Sets the functions of this LogAnalyticsSource. - source functions + The source functions. :param functions: The functions of this LogAnalyticsSource. @@ -714,7 +714,7 @@ def functions(self, functions): def source_id(self): """ Gets the source_id of this LogAnalyticsSource. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSource. @@ -726,7 +726,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSource. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSource. @@ -738,7 +738,7 @@ def source_id(self, source_id): def name(self): """ Gets the name of this LogAnalyticsSource. - source internal name + The source internal name. :return: The name of this LogAnalyticsSource. @@ -750,7 +750,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsSource. - source internal name + The source internal name. :param name: The name of this LogAnalyticsSource. @@ -762,7 +762,7 @@ def name(self, name): def is_secure_content(self): """ Gets the is_secure_content of this LogAnalyticsSource. - is secure content flag + A flag indicating whether or not the source content is secure. :return: The is_secure_content of this LogAnalyticsSource. @@ -774,7 +774,7 @@ def is_secure_content(self): def is_secure_content(self, is_secure_content): """ Sets the is_secure_content of this LogAnalyticsSource. - is secure content flag + A flag indicating whether or not the source content is secure. :param is_secure_content: The is_secure_content of this LogAnalyticsSource. @@ -786,7 +786,8 @@ def is_secure_content(self, is_secure_content): def is_system(self): """ Gets the is_system of this LogAnalyticsSource. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSource. @@ -798,7 +799,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSource. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSource. @@ -810,7 +812,7 @@ def is_system(self, is_system): def parsers(self): """ Gets the parsers of this LogAnalyticsSource. - parser list + The list of parsers used by the source. :return: The parsers of this LogAnalyticsSource. @@ -822,7 +824,7 @@ def parsers(self): def parsers(self, parsers): """ Sets the parsers of this LogAnalyticsSource. - parser list + The list of parsers used by the source. :param parsers: The parsers of this LogAnalyticsSource. @@ -834,7 +836,7 @@ def parsers(self, parsers): def is_auto_association_enabled(self): """ Gets the is_auto_association_enabled of this LogAnalyticsSource. - rule auto association enabled flag + A flag indicating whether or not the source is marked for auto-association. :return: The is_auto_association_enabled of this LogAnalyticsSource. @@ -846,7 +848,7 @@ def is_auto_association_enabled(self): def is_auto_association_enabled(self, is_auto_association_enabled): """ Sets the is_auto_association_enabled of this LogAnalyticsSource. - rule auto association enabled flag + A flag indicating whether or not the source is marked for auto-association. :param is_auto_association_enabled: The is_auto_association_enabled of this LogAnalyticsSource. @@ -858,7 +860,7 @@ def is_auto_association_enabled(self, is_auto_association_enabled): def is_auto_association_override(self): """ Gets the is_auto_association_override of this LogAnalyticsSource. - rule auto association override + A flag indicating whether or not the auto-association state should be overriden. :return: The is_auto_association_override of this LogAnalyticsSource. @@ -870,7 +872,7 @@ def is_auto_association_override(self): def is_auto_association_override(self, is_auto_association_override): """ Sets the is_auto_association_override of this LogAnalyticsSource. - rule auto association override + A flag indicating whether or not the auto-association state should be overriden. :param is_auto_association_override: The is_auto_association_override of this LogAnalyticsSource. @@ -882,7 +884,7 @@ def is_auto_association_override(self, is_auto_association_override): def rule_id(self): """ Gets the rule_id of this LogAnalyticsSource. - rule Id + The rule unique identifier. :return: The rule_id of this LogAnalyticsSource. @@ -894,7 +896,7 @@ def rule_id(self): def rule_id(self, rule_id): """ Sets the rule_id of this LogAnalyticsSource. - rule Id + The rule unique identifier. :param rule_id: The rule_id of this LogAnalyticsSource. @@ -906,7 +908,7 @@ def rule_id(self, rule_id): def type_name(self): """ Gets the type_name of this LogAnalyticsSource. - source type internal name + The source type internal name. :return: The type_name of this LogAnalyticsSource. @@ -918,7 +920,7 @@ def type_name(self): def type_name(self, type_name): """ Sets the type_name of this LogAnalyticsSource. - source type internal name + The source type internal name. :param type_name: The type_name of this LogAnalyticsSource. @@ -930,7 +932,7 @@ def type_name(self, type_name): def type_display_name(self): """ Gets the type_display_name of this LogAnalyticsSource. - source type name + The source type name. :return: The type_display_name of this LogAnalyticsSource. @@ -942,7 +944,7 @@ def type_display_name(self): def type_display_name(self, type_display_name): """ Sets the type_display_name of this LogAnalyticsSource. - source type name + The source type name. :param type_display_name: The type_display_name of this LogAnalyticsSource. @@ -954,7 +956,7 @@ def type_display_name(self, type_display_name): def warning_config(self): """ Gets the warning_config of this LogAnalyticsSource. - source warning configuration + The source warning configuration. :return: The warning_config of this LogAnalyticsSource. @@ -966,7 +968,7 @@ def warning_config(self): def warning_config(self, warning_config): """ Sets the warning_config of this LogAnalyticsSource. - source warning configuration + The source warning configuration. :param warning_config: The warning_config of this LogAnalyticsSource. @@ -978,7 +980,7 @@ def warning_config(self, warning_config): def metadata_fields(self): """ Gets the metadata_fields of this LogAnalyticsSource. - source metadata fields + The source metadata fields. :return: The metadata_fields of this LogAnalyticsSource. @@ -990,7 +992,7 @@ def metadata_fields(self): def metadata_fields(self, metadata_fields): """ Sets the metadata_fields of this LogAnalyticsSource. - source metadata fields + The source metadata fields. :param metadata_fields: The metadata_fields of this LogAnalyticsSource. @@ -1002,7 +1004,7 @@ def metadata_fields(self, metadata_fields): def label_definitions(self): """ Gets the label_definitions of this LogAnalyticsSource. - tags + The labls used by the source. :return: The label_definitions of this LogAnalyticsSource. @@ -1014,7 +1016,7 @@ def label_definitions(self): def label_definitions(self, label_definitions): """ Sets the label_definitions of this LogAnalyticsSource. - tags + The labls used by the source. :param label_definitions: The label_definitions of this LogAnalyticsSource. @@ -1026,7 +1028,7 @@ def label_definitions(self, label_definitions): def entity_types(self): """ Gets the entity_types of this LogAnalyticsSource. - Entity types + The entity types. :return: The entity_types of this LogAnalyticsSource. @@ -1038,7 +1040,7 @@ def entity_types(self): def entity_types(self, entity_types): """ Sets the entity_types of this LogAnalyticsSource. - Entity types + The entity types. :param entity_types: The entity_types of this LogAnalyticsSource. @@ -1050,7 +1052,7 @@ def entity_types(self, entity_types): def is_timezone_override(self): """ Gets the is_timezone_override of this LogAnalyticsSource. - time zone override + A flag indicating whether or not the source has a time zone override. :return: The is_timezone_override of this LogAnalyticsSource. @@ -1062,7 +1064,7 @@ def is_timezone_override(self): def is_timezone_override(self, is_timezone_override): """ Sets the is_timezone_override of this LogAnalyticsSource. - time zone override + A flag indicating whether or not the source has a time zone override. :param is_timezone_override: The is_timezone_override of this LogAnalyticsSource. @@ -1074,7 +1076,7 @@ def is_timezone_override(self, is_timezone_override): def user_parsers(self): """ Gets the user_parsers of this LogAnalyticsSource. - source parser list + An array of custom parsers. :return: The user_parsers of this LogAnalyticsSource. @@ -1086,7 +1088,7 @@ def user_parsers(self): def user_parsers(self, user_parsers): """ Sets the user_parsers of this LogAnalyticsSource. - source parser list + An array of custom parsers. :param user_parsers: The user_parsers of this LogAnalyticsSource. @@ -1098,7 +1100,7 @@ def user_parsers(self, user_parsers): def time_updated(self): """ Gets the time_updated of this LogAnalyticsSource. - timeUpdated + The last updated date. :return: The time_updated of this LogAnalyticsSource. @@ -1110,7 +1112,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsSource. - timeUpdated + The last updated date. :param time_updated: The time_updated of this LogAnalyticsSource. diff --git a/src/oci/log_analytics/models/log_analytics_source_collection.py b/src/oci/log_analytics/models/log_analytics_source_collection.py index 35634b5440..18c4ff855b 100644 --- a/src/oci/log_analytics/models/log_analytics_source_collection.py +++ b/src/oci/log_analytics/models/log_analytics_source_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsSourceCollection. - list of sources + An array of sources. :return: The items of this LogAnalyticsSourceCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsSourceCollection. - list of sources + An array of sources. :param items: The items of this LogAnalyticsSourceCollection. diff --git a/src/oci/log_analytics/models/log_analytics_source_data_filter.py b/src/oci/log_analytics/models/log_analytics_source_data_filter.py index 8e4b96b0ce..f3bb09ce87 100644 --- a/src/oci/log_analytics/models/log_analytics_source_data_filter.py +++ b/src/oci/log_analytics/models/log_analytics_source_data_filter.py @@ -146,7 +146,7 @@ def __init__(self, **kwargs): def description(self): """ Gets the description of this LogAnalyticsSourceDataFilter. - description + The filter description. :return: The description of this LogAnalyticsSourceDataFilter. @@ -158,7 +158,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsSourceDataFilter. - description + The filter description. :param description: The description of this LogAnalyticsSourceDataFilter. @@ -170,7 +170,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsSourceDataFilter. - display name + The filter display name. :return: The display_name of this LogAnalyticsSourceDataFilter. @@ -182,7 +182,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsSourceDataFilter. - display name + The filter display name. :param display_name: The display_name of this LogAnalyticsSourceDataFilter. @@ -194,7 +194,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsSourceDataFilter. - edit version + The filter edit version. :return: The edit_version of this LogAnalyticsSourceDataFilter. @@ -206,7 +206,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsSourceDataFilter. - edit version + The filter edit version. :param edit_version: The edit_version of this LogAnalyticsSourceDataFilter. @@ -218,7 +218,7 @@ def edit_version(self, edit_version): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourceDataFilter. - enabled + A flag inidcating whether or not the filter is enabled. :return: The is_enabled of this LogAnalyticsSourceDataFilter. @@ -230,7 +230,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourceDataFilter. - enabled + A flag inidcating whether or not the filter is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourceDataFilter. @@ -242,7 +242,7 @@ def is_enabled(self, is_enabled): def field_name(self): """ Gets the field_name of this LogAnalyticsSourceDataFilter. - field internal name + The field internal name. :return: The field_name of this LogAnalyticsSourceDataFilter. @@ -254,7 +254,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this LogAnalyticsSourceDataFilter. - field internal name + The field internal name. :param field_name: The field_name of this LogAnalyticsSourceDataFilter. @@ -266,7 +266,7 @@ def field_name(self, field_name): def hash_type(self): """ Gets the hash_type of this LogAnalyticsSourceDataFilter. - hash type + The hash type. :return: The hash_type of this LogAnalyticsSourceDataFilter. @@ -278,7 +278,7 @@ def hash_type(self): def hash_type(self, hash_type): """ Sets the hash_type of this LogAnalyticsSourceDataFilter. - hash type + The hash type. :param hash_type: The hash_type of this LogAnalyticsSourceDataFilter. @@ -290,7 +290,7 @@ def hash_type(self, hash_type): def data_filter_id(self): """ Gets the data_filter_id of this LogAnalyticsSourceDataFilter. - filter Id + The filter unique identifier. :return: The data_filter_id of this LogAnalyticsSourceDataFilter. @@ -302,7 +302,7 @@ def data_filter_id(self): def data_filter_id(self, data_filter_id): """ Sets the data_filter_id of this LogAnalyticsSourceDataFilter. - filter Id + The filter unique identifier. :param data_filter_id: The data_filter_id of this LogAnalyticsSourceDataFilter. @@ -314,7 +314,8 @@ def data_filter_id(self, data_filter_id): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceDataFilter. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceDataFilter. @@ -326,7 +327,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceDataFilter. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceDataFilter. @@ -338,7 +340,7 @@ def is_system(self, is_system): def match_regular_expression(self): """ Gets the match_regular_expression of this LogAnalyticsSourceDataFilter. - regular expression match + The regular expression for matching. :return: The match_regular_expression of this LogAnalyticsSourceDataFilter. @@ -350,7 +352,7 @@ def match_regular_expression(self): def match_regular_expression(self, match_regular_expression): """ Sets the match_regular_expression of this LogAnalyticsSourceDataFilter. - regular expression match + The regular expression for matching. :param match_regular_expression: The match_regular_expression of this LogAnalyticsSourceDataFilter. @@ -362,7 +364,7 @@ def match_regular_expression(self, match_regular_expression): def order(self): """ Gets the order of this LogAnalyticsSourceDataFilter. - order + The filter order. :return: The order of this LogAnalyticsSourceDataFilter. @@ -374,7 +376,7 @@ def order(self): def order(self, order): """ Sets the order of this LogAnalyticsSourceDataFilter. - order + The filter order. :param order: The order of this LogAnalyticsSourceDataFilter. @@ -386,7 +388,7 @@ def order(self, order): def path(self): """ Gets the path of this LogAnalyticsSourceDataFilter. - path + The filter path. :return: The path of this LogAnalyticsSourceDataFilter. @@ -398,7 +400,7 @@ def path(self): def path(self, path): """ Sets the path of this LogAnalyticsSourceDataFilter. - path + The filter path. :param path: The path of this LogAnalyticsSourceDataFilter. @@ -410,7 +412,7 @@ def path(self, path): def replacement_string(self): """ Gets the replacement_string of this LogAnalyticsSourceDataFilter. - replacement string + The replacement string. :return: The replacement_string of this LogAnalyticsSourceDataFilter. @@ -422,7 +424,7 @@ def replacement_string(self): def replacement_string(self, replacement_string): """ Sets the replacement_string of this LogAnalyticsSourceDataFilter. - replacement string + The replacement string. :param replacement_string: The replacement_string of this LogAnalyticsSourceDataFilter. @@ -434,7 +436,7 @@ def replacement_string(self, replacement_string): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceDataFilter. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourceDataFilter. @@ -446,7 +448,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceDataFilter. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourceDataFilter. @@ -458,7 +460,7 @@ def source_id(self, source_id): def filter_type(self): """ Gets the filter_type of this LogAnalyticsSourceDataFilter. - filterType + The filter type. Allowed values for this property are: "MASK", "HASH_MASK", "DROP_LOG_ENTRY", "DROP_STRING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -473,7 +475,7 @@ def filter_type(self): def filter_type(self, filter_type): """ Sets the filter_type of this LogAnalyticsSourceDataFilter. - filterType + The filter type. :param filter_type: The filter_type of this LogAnalyticsSourceDataFilter. diff --git a/src/oci/log_analytics/models/log_analytics_source_entity_type.py b/src/oci/log_analytics/models/log_analytics_source_entity_type.py index b4da7a8a0f..557b15cef9 100644 --- a/src/oci/log_analytics/models/log_analytics_source_entity_type.py +++ b/src/oci/log_analytics/models/log_analytics_source_entity_type.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceEntityType. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourceEntityType. @@ -70,7 +70,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceEntityType. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourceEntityType. @@ -82,7 +82,7 @@ def source_id(self, source_id): def entity_type(self): """ Gets the entity_type of this LogAnalyticsSourceEntityType. - Entity type + The entity type. :return: The entity_type of this LogAnalyticsSourceEntityType. @@ -94,7 +94,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsSourceEntityType. - Entity type + The entity type. :param entity_type: The entity_type of this LogAnalyticsSourceEntityType. @@ -106,7 +106,7 @@ def entity_type(self, entity_type): def entity_type_category(self): """ Gets the entity_type_category of this LogAnalyticsSourceEntityType. - type category + The type category. :return: The entity_type_category of this LogAnalyticsSourceEntityType. @@ -118,7 +118,7 @@ def entity_type_category(self): def entity_type_category(self, entity_type_category): """ Sets the entity_type_category of this LogAnalyticsSourceEntityType. - type category + The type category. :param entity_type_category: The entity_type_category of this LogAnalyticsSourceEntityType. @@ -130,7 +130,7 @@ def entity_type_category(self, entity_type_category): def entity_type_display_name(self): """ Gets the entity_type_display_name of this LogAnalyticsSourceEntityType. - Entity type display name + The entity type display name. :return: The entity_type_display_name of this LogAnalyticsSourceEntityType. @@ -142,7 +142,7 @@ def entity_type_display_name(self): def entity_type_display_name(self, entity_type_display_name): """ Sets the entity_type_display_name of this LogAnalyticsSourceEntityType. - Entity type display name + The entity type display name. :param entity_type_display_name: The entity_type_display_name of this LogAnalyticsSourceEntityType. diff --git a/src/oci/log_analytics/models/log_analytics_source_extended_field_definition.py b/src/oci/log_analytics/models/log_analytics_source_extended_field_definition.py index 049f7f7b70..b680641ee0 100644 --- a/src/oci/log_analytics/models/log_analytics_source_extended_field_definition.py +++ b/src/oci/log_analytics/models/log_analytics_source_extended_field_definition.py @@ -162,7 +162,7 @@ def field(self, field): def display_regular_expression(self): """ Gets the display_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - display regular expression + The regular expression. :return: The display_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -174,7 +174,7 @@ def display_regular_expression(self): def display_regular_expression(self, display_regular_expression): """ Sets the display_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - display regular expression + The regular expression. :param display_regular_expression: The display_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -186,7 +186,7 @@ def display_regular_expression(self, display_regular_expression): def extended_fields(self): """ Gets the extended_fields of this LogAnalyticsSourceExtendedFieldDefinition. - extended fields + An array of extended fields. :return: The extended_fields of this LogAnalyticsSourceExtendedFieldDefinition. @@ -198,7 +198,7 @@ def extended_fields(self): def extended_fields(self, extended_fields): """ Sets the extended_fields of this LogAnalyticsSourceExtendedFieldDefinition. - extended fields + An array of extended fields. :param extended_fields: The extended_fields of this LogAnalyticsSourceExtendedFieldDefinition. @@ -210,7 +210,7 @@ def extended_fields(self, extended_fields): def base_field_name(self): """ Gets the base_field_name of this LogAnalyticsSourceExtendedFieldDefinition. - base field internal name + The base field internal name. :return: The base_field_name of this LogAnalyticsSourceExtendedFieldDefinition. @@ -222,7 +222,7 @@ def base_field_name(self): def base_field_name(self, base_field_name): """ Sets the base_field_name of this LogAnalyticsSourceExtendedFieldDefinition. - base field internal name + The base field internal name. :param base_field_name: The base_field_name of this LogAnalyticsSourceExtendedFieldDefinition. @@ -234,7 +234,7 @@ def base_field_name(self, base_field_name): def base_field_log_text(self): """ Gets the base_field_log_text of this LogAnalyticsSourceExtendedFieldDefinition. - base field log text + The base field log text. :return: The base_field_log_text of this LogAnalyticsSourceExtendedFieldDefinition. @@ -246,7 +246,7 @@ def base_field_log_text(self): def base_field_log_text(self, base_field_log_text): """ Sets the base_field_log_text of this LogAnalyticsSourceExtendedFieldDefinition. - base field log text + The base field log text. :param base_field_log_text: The base_field_log_text of this LogAnalyticsSourceExtendedFieldDefinition. @@ -258,7 +258,7 @@ def base_field_log_text(self, base_field_log_text): def condition_data_type(self): """ Gets the condition_data_type of this LogAnalyticsSourceExtendedFieldDefinition. - conditional data type + The conditional data type. :return: The condition_data_type of this LogAnalyticsSourceExtendedFieldDefinition. @@ -270,7 +270,7 @@ def condition_data_type(self): def condition_data_type(self, condition_data_type): """ Sets the condition_data_type of this LogAnalyticsSourceExtendedFieldDefinition. - conditional data type + The conditional data type. :param condition_data_type: The condition_data_type of this LogAnalyticsSourceExtendedFieldDefinition. @@ -282,7 +282,7 @@ def condition_data_type(self, condition_data_type): def condition_field(self): """ Gets the condition_field of this LogAnalyticsSourceExtendedFieldDefinition. - conditional field + The onditional field. :return: The condition_field of this LogAnalyticsSourceExtendedFieldDefinition. @@ -294,7 +294,7 @@ def condition_field(self): def condition_field(self, condition_field): """ Sets the condition_field of this LogAnalyticsSourceExtendedFieldDefinition. - conditional field + The onditional field. :param condition_field: The condition_field of this LogAnalyticsSourceExtendedFieldDefinition. @@ -306,7 +306,7 @@ def condition_field(self, condition_field): def condition_operator(self): """ Gets the condition_operator of this LogAnalyticsSourceExtendedFieldDefinition. - conditional operator + The conditional operator. :return: The condition_operator of this LogAnalyticsSourceExtendedFieldDefinition. @@ -318,7 +318,7 @@ def condition_operator(self): def condition_operator(self, condition_operator): """ Sets the condition_operator of this LogAnalyticsSourceExtendedFieldDefinition. - conditional operator + The conditional operator. :param condition_operator: The condition_operator of this LogAnalyticsSourceExtendedFieldDefinition. @@ -330,7 +330,7 @@ def condition_operator(self, condition_operator): def condition_value(self): """ Gets the condition_value of this LogAnalyticsSourceExtendedFieldDefinition. - conditional value + The conditional value. :return: The condition_value of this LogAnalyticsSourceExtendedFieldDefinition. @@ -342,7 +342,7 @@ def condition_value(self): def condition_value(self, condition_value): """ Sets the condition_value of this LogAnalyticsSourceExtendedFieldDefinition. - conditional value + The conditional value. :param condition_value: The condition_value of this LogAnalyticsSourceExtendedFieldDefinition. @@ -354,7 +354,7 @@ def condition_value(self, condition_value): def converted_regular_expression(self): """ Gets the converted_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - converted regular expression + The converted regular expression. :return: The converted_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -366,7 +366,7 @@ def converted_regular_expression(self): def converted_regular_expression(self, converted_regular_expression): """ Sets the converted_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - converted regular expression + The converted regular expression. :param converted_regular_expression: The converted_regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -378,7 +378,7 @@ def converted_regular_expression(self, converted_regular_expression): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourceExtendedFieldDefinition. - enabled + A flag inidcating whether or not the extended definition is enabled. :return: The is_enabled of this LogAnalyticsSourceExtendedFieldDefinition. @@ -390,7 +390,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourceExtendedFieldDefinition. - enabled + A flag inidcating whether or not the extended definition is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourceExtendedFieldDefinition. @@ -402,7 +402,7 @@ def is_enabled(self, is_enabled): def extended_field_definition_id(self): """ Gets the extended_field_definition_id of this LogAnalyticsSourceExtendedFieldDefinition. - id + The extended field definition unique identifier. :return: The extended_field_definition_id of this LogAnalyticsSourceExtendedFieldDefinition. @@ -414,7 +414,7 @@ def extended_field_definition_id(self): def extended_field_definition_id(self, extended_field_definition_id): """ Sets the extended_field_definition_id of this LogAnalyticsSourceExtendedFieldDefinition. - id + The extended field definition unique identifier. :param extended_field_definition_id: The extended_field_definition_id of this LogAnalyticsSourceExtendedFieldDefinition. @@ -426,7 +426,8 @@ def extended_field_definition_id(self, extended_field_definition_id): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceExtendedFieldDefinition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceExtendedFieldDefinition. @@ -438,7 +439,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceExtendedFieldDefinition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceExtendedFieldDefinition. @@ -450,7 +452,7 @@ def is_system(self, is_system): def regular_expression(self): """ Gets the regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - regular expression + The regular expression. :return: The regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -462,7 +464,7 @@ def regular_expression(self): def regular_expression(self, regular_expression): """ Sets the regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. - regular expression + The regular expression. :param regular_expression: The regular_expression of this LogAnalyticsSourceExtendedFieldDefinition. @@ -474,7 +476,7 @@ def regular_expression(self, regular_expression): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceExtendedFieldDefinition. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourceExtendedFieldDefinition. @@ -486,7 +488,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceExtendedFieldDefinition. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourceExtendedFieldDefinition. @@ -498,7 +500,7 @@ def source_id(self, source_id): def time_updated(self): """ Gets the time_updated of this LogAnalyticsSourceExtendedFieldDefinition. - last updated date + The last updated date. :return: The time_updated of this LogAnalyticsSourceExtendedFieldDefinition. @@ -510,7 +512,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsSourceExtendedFieldDefinition. - last updated date + The last updated date. :param time_updated: The time_updated of this LogAnalyticsSourceExtendedFieldDefinition. diff --git a/src/oci/log_analytics/models/log_analytics_source_extended_field_definition_collection.py b/src/oci/log_analytics/models/log_analytics_source_extended_field_definition_collection.py index def7e84a67..38234fab82 100644 --- a/src/oci/log_analytics/models/log_analytics_source_extended_field_definition_collection.py +++ b/src/oci/log_analytics/models/log_analytics_source_extended_field_definition_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsSourceExtendedFieldDefinitionCollection. - list of extended field definitions + An array of extended field definitions. :return: The items of this LogAnalyticsSourceExtendedFieldDefinitionCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsSourceExtendedFieldDefinitionCollection. - list of extended field definitions + An array of extended field definitions. :param items: The items of this LogAnalyticsSourceExtendedFieldDefinitionCollection. diff --git a/src/oci/log_analytics/models/log_analytics_source_function.py b/src/oci/log_analytics/models/log_analytics_source_function.py index d6dfe0d95d..9143e317c0 100644 --- a/src/oci/log_analytics/models/log_analytics_source_function.py +++ b/src/oci/log_analytics/models/log_analytics_source_function.py @@ -13,6 +13,14 @@ class LogAnalyticsSourceFunction(object): LogAnalyticsSourceFunction """ + #: A constant which can be used with the function_name property of a LogAnalyticsSourceFunction. + #: This constant has a value of "GEOLOCATION" + FUNCTION_NAME_GEOLOCATION = "GEOLOCATION" + + #: A constant which can be used with the function_name property of a LogAnalyticsSourceFunction. + #: This constant has a value of "LOOKUP" + FUNCTION_NAME_LOOKUP = "LOOKUP" + def __init__(self, **kwargs): """ Initializes a new LogAnalyticsSourceFunction object with values from keyword arguments. @@ -30,6 +38,20 @@ def __init__(self, **kwargs): The value to assign to the function property of this LogAnalyticsSourceFunction. :type function: oci.log_analytics.models.LogAnalyticsMetaFunction + :param function_name: + The value to assign to the function_name property of this LogAnalyticsSourceFunction. + Allowed values for this property are: "GEOLOCATION", "LOOKUP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type function_name: str + + :param function_reference: + The value to assign to the function_reference property of this LogAnalyticsSourceFunction. + :type function_reference: str + + :param source_reference: + The value to assign to the source_reference property of this LogAnalyticsSourceFunction. + :type source_reference: str + :param function_id: The value to assign to the function_id property of this LogAnalyticsSourceFunction. :type function_id: int @@ -71,6 +93,9 @@ def __init__(self, **kwargs): 'arguments': 'list[LogAnalyticsMetaFunctionArgument]', 'is_enabled': 'bool', 'function': 'LogAnalyticsMetaFunction', + 'function_name': 'str', + 'function_reference': 'str', + 'source_reference': 'str', 'function_id': 'int', 'order': 'int', 'is_system': 'bool', @@ -86,6 +111,9 @@ def __init__(self, **kwargs): 'arguments': 'arguments', 'is_enabled': 'isEnabled', 'function': 'function', + 'function_name': 'functionName', + 'function_reference': 'functionReference', + 'source_reference': 'sourceReference', 'function_id': 'functionId', 'order': 'order', 'is_system': 'isSystem', @@ -100,6 +128,9 @@ def __init__(self, **kwargs): self._arguments = None self._is_enabled = None self._function = None + self._function_name = None + self._function_reference = None + self._source_reference = None self._function_id = None self._order = None self._is_system = None @@ -114,7 +145,7 @@ def __init__(self, **kwargs): def arguments(self): """ Gets the arguments of this LogAnalyticsSourceFunction. - argument + The function argument. :return: The arguments of this LogAnalyticsSourceFunction. @@ -126,7 +157,7 @@ def arguments(self): def arguments(self, arguments): """ Sets the arguments of this LogAnalyticsSourceFunction. - argument + The function argument. :param arguments: The arguments of this LogAnalyticsSourceFunction. @@ -138,7 +169,7 @@ def arguments(self, arguments): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourceFunction. - enabled flag + A flag inidcating whether or not the source function is enabled. :return: The is_enabled of this LogAnalyticsSourceFunction. @@ -150,7 +181,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourceFunction. - enabled flag + A flag inidcating whether or not the source function is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourceFunction. @@ -178,11 +209,89 @@ def function(self, function): """ self._function = function + @property + def function_name(self): + """ + Gets the function_name of this LogAnalyticsSourceFunction. + The source function name + + Allowed values for this property are: "GEOLOCATION", "LOOKUP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The function_name of this LogAnalyticsSourceFunction. + :rtype: str + """ + return self._function_name + + @function_name.setter + def function_name(self, function_name): + """ + Sets the function_name of this LogAnalyticsSourceFunction. + The source function name + + + :param function_name: The function_name of this LogAnalyticsSourceFunction. + :type: str + """ + allowed_values = ["GEOLOCATION", "LOOKUP"] + if not value_allowed_none_or_none_sentinel(function_name, allowed_values): + function_name = 'UNKNOWN_ENUM_VALUE' + self._function_name = function_name + + @property + def function_reference(self): + """ + Gets the function_reference of this LogAnalyticsSourceFunction. + The source function unique identifier as a string. + + + :return: The function_reference of this LogAnalyticsSourceFunction. + :rtype: str + """ + return self._function_reference + + @function_reference.setter + def function_reference(self, function_reference): + """ + Sets the function_reference of this LogAnalyticsSourceFunction. + The source function unique identifier as a string. + + + :param function_reference: The function_reference of this LogAnalyticsSourceFunction. + :type: str + """ + self._function_reference = function_reference + + @property + def source_reference(self): + """ + Gets the source_reference of this LogAnalyticsSourceFunction. + The source unique identifier as a string. + + + :return: The source_reference of this LogAnalyticsSourceFunction. + :rtype: str + """ + return self._source_reference + + @source_reference.setter + def source_reference(self, source_reference): + """ + Sets the source_reference of this LogAnalyticsSourceFunction. + The source unique identifier as a string. + + + :param source_reference: The source_reference of this LogAnalyticsSourceFunction. + :type: str + """ + self._source_reference = source_reference + @property def function_id(self): """ Gets the function_id of this LogAnalyticsSourceFunction. - source function Id + The source function unique identifier. :return: The function_id of this LogAnalyticsSourceFunction. @@ -194,7 +303,7 @@ def function_id(self): def function_id(self, function_id): """ Sets the function_id of this LogAnalyticsSourceFunction. - source function Id + The source function unique identifier. :param function_id: The function_id of this LogAnalyticsSourceFunction. @@ -206,7 +315,7 @@ def function_id(self, function_id): def order(self): """ Gets the order of this LogAnalyticsSourceFunction. - source function order + The source function order. :return: The order of this LogAnalyticsSourceFunction. @@ -218,7 +327,7 @@ def order(self): def order(self, order): """ Sets the order of this LogAnalyticsSourceFunction. - source function order + The source function order. :param order: The order of this LogAnalyticsSourceFunction. @@ -230,7 +339,8 @@ def order(self, order): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceFunction. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceFunction. @@ -242,7 +352,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceFunction. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceFunction. @@ -254,7 +365,7 @@ def is_system(self, is_system): def lookup_column(self): """ Gets the lookup_column of this LogAnalyticsSourceFunction. - column + The lookup column. :return: The lookup_column of this LogAnalyticsSourceFunction. @@ -266,7 +377,7 @@ def lookup_column(self): def lookup_column(self, lookup_column): """ Sets the lookup_column of this LogAnalyticsSourceFunction. - column + The lookup column. :param lookup_column: The lookup_column of this LogAnalyticsSourceFunction. @@ -278,7 +389,7 @@ def lookup_column(self, lookup_column): def lookup_column_position(self): """ Gets the lookup_column_position of this LogAnalyticsSourceFunction. - column position + The lookup column position. :return: The lookup_column_position of this LogAnalyticsSourceFunction. @@ -290,7 +401,7 @@ def lookup_column_position(self): def lookup_column_position(self, lookup_column_position): """ Sets the lookup_column_position of this LogAnalyticsSourceFunction. - column position + The lookup column position. :param lookup_column_position: The lookup_column_position of this LogAnalyticsSourceFunction. @@ -302,7 +413,7 @@ def lookup_column_position(self, lookup_column_position): def lookup_display_name(self): """ Gets the lookup_display_name of this LogAnalyticsSourceFunction. - lookup display name + The lookup display name. :return: The lookup_display_name of this LogAnalyticsSourceFunction. @@ -314,7 +425,7 @@ def lookup_display_name(self): def lookup_display_name(self, lookup_display_name): """ Sets the lookup_display_name of this LogAnalyticsSourceFunction. - lookup display name + The lookup display name. :param lookup_display_name: The lookup_display_name of this LogAnalyticsSourceFunction. @@ -326,7 +437,7 @@ def lookup_display_name(self, lookup_display_name): def lookup_mode(self): """ Gets the lookup_mode of this LogAnalyticsSourceFunction. - lookup mode + The lookup mode. :return: The lookup_mode of this LogAnalyticsSourceFunction. @@ -338,7 +449,7 @@ def lookup_mode(self): def lookup_mode(self, lookup_mode): """ Sets the lookup_mode of this LogAnalyticsSourceFunction. - lookup mode + The lookup mode. :param lookup_mode: The lookup_mode of this LogAnalyticsSourceFunction. @@ -350,7 +461,7 @@ def lookup_mode(self, lookup_mode): def lookup_table(self): """ Gets the lookup_table of this LogAnalyticsSourceFunction. - lookup table + The lookup table. :return: The lookup_table of this LogAnalyticsSourceFunction. @@ -362,7 +473,7 @@ def lookup_table(self): def lookup_table(self, lookup_table): """ Sets the lookup_table of this LogAnalyticsSourceFunction. - lookup table + The lookup table. :param lookup_table: The lookup_table of this LogAnalyticsSourceFunction. @@ -374,7 +485,7 @@ def lookup_table(self, lookup_table): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceFunction. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourceFunction. @@ -386,7 +497,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceFunction. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourceFunction. diff --git a/src/oci/log_analytics/models/log_analytics_source_label_condition.py b/src/oci/log_analytics/models/log_analytics_source_label_condition.py index ef897b0d8b..8b11bb7e22 100644 --- a/src/oci/log_analytics/models/log_analytics_source_label_condition.py +++ b/src/oci/log_analytics/models/log_analytics_source_label_condition.py @@ -156,7 +156,7 @@ def __init__(self, **kwargs): def message(self): """ Gets the message of this LogAnalyticsSourceLabelCondition. - message + The message. :return: The message of this LogAnalyticsSourceLabelCondition. @@ -168,7 +168,7 @@ def message(self): def message(self, message): """ Sets the message of this LogAnalyticsSourceLabelCondition. - message + The message. :param message: The message of this LogAnalyticsSourceLabelCondition. @@ -180,7 +180,7 @@ def message(self, message): def is_visible(self): """ Gets the is_visible of this LogAnalyticsSourceLabelCondition. - visible flag + A flag indicating whether or not the label condition is visible. :return: The is_visible of this LogAnalyticsSourceLabelCondition. @@ -192,7 +192,7 @@ def is_visible(self): def is_visible(self, is_visible): """ Sets the is_visible of this LogAnalyticsSourceLabelCondition. - visible flag + A flag indicating whether or not the label condition is visible. :param is_visible: The is_visible of this LogAnalyticsSourceLabelCondition. @@ -204,7 +204,7 @@ def is_visible(self, is_visible): def block_condition_field(self): """ Gets the block_condition_field of this LogAnalyticsSourceLabelCondition. - block condition field + The block condition field. :return: The block_condition_field of this LogAnalyticsSourceLabelCondition. @@ -216,7 +216,7 @@ def block_condition_field(self): def block_condition_field(self, block_condition_field): """ Sets the block_condition_field of this LogAnalyticsSourceLabelCondition. - block condition field + The block condition field. :param block_condition_field: The block_condition_field of this LogAnalyticsSourceLabelCondition. @@ -228,7 +228,7 @@ def block_condition_field(self, block_condition_field): def block_condition_operator(self): """ Gets the block_condition_operator of this LogAnalyticsSourceLabelCondition. - block condition operator + The block condition operator. :return: The block_condition_operator of this LogAnalyticsSourceLabelCondition. @@ -240,7 +240,7 @@ def block_condition_operator(self): def block_condition_operator(self, block_condition_operator): """ Sets the block_condition_operator of this LogAnalyticsSourceLabelCondition. - block condition operator + The block condition operator. :param block_condition_operator: The block_condition_operator of this LogAnalyticsSourceLabelCondition. @@ -252,7 +252,7 @@ def block_condition_operator(self, block_condition_operator): def block_condition_value(self): """ Gets the block_condition_value of this LogAnalyticsSourceLabelCondition. - block condition value + The block condition value. :return: The block_condition_value of this LogAnalyticsSourceLabelCondition. @@ -264,7 +264,7 @@ def block_condition_value(self): def block_condition_value(self, block_condition_value): """ Sets the block_condition_value of this LogAnalyticsSourceLabelCondition. - block condition value + The block condition value. :param block_condition_value: The block_condition_value of this LogAnalyticsSourceLabelCondition. @@ -276,7 +276,7 @@ def block_condition_value(self, block_condition_value): def label_condition_value(self): """ Gets the label_condition_value of this LogAnalyticsSourceLabelCondition. - condition value + The condition value. :return: The label_condition_value of this LogAnalyticsSourceLabelCondition. @@ -288,7 +288,7 @@ def label_condition_value(self): def label_condition_value(self, label_condition_value): """ Sets the label_condition_value of this LogAnalyticsSourceLabelCondition. - condition value + The condition value. :param label_condition_value: The label_condition_value of this LogAnalyticsSourceLabelCondition. @@ -300,7 +300,7 @@ def label_condition_value(self, label_condition_value): def label_condition_values(self): """ Gets the label_condition_values of this LogAnalyticsSourceLabelCondition. - list of condition values + A list of condition values. :return: The label_condition_values of this LogAnalyticsSourceLabelCondition. @@ -312,7 +312,7 @@ def label_condition_values(self): def label_condition_values(self, label_condition_values): """ Sets the label_condition_values of this LogAnalyticsSourceLabelCondition. - list of condition values + A list of condition values. :param label_condition_values: The label_condition_values of this LogAnalyticsSourceLabelCondition. @@ -324,7 +324,7 @@ def label_condition_values(self, label_condition_values): def content_example(self): """ Gets the content_example of this LogAnalyticsSourceLabelCondition. - content example + The content example. :return: The content_example of this LogAnalyticsSourceLabelCondition. @@ -336,7 +336,7 @@ def content_example(self): def content_example(self, content_example): """ Sets the content_example of this LogAnalyticsSourceLabelCondition. - content example + The content example. :param content_example: The content_example of this LogAnalyticsSourceLabelCondition. @@ -348,7 +348,7 @@ def content_example(self, content_example): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourceLabelCondition. - enabled + A flag inidcating whether or not the condition is enabled. :return: The is_enabled of this LogAnalyticsSourceLabelCondition. @@ -360,7 +360,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourceLabelCondition. - enabled + A flag inidcating whether or not the condition is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourceLabelCondition. @@ -372,7 +372,7 @@ def is_enabled(self, is_enabled): def field_name(self): """ Gets the field_name of this LogAnalyticsSourceLabelCondition. - field internal name + The internal field name. :return: The field_name of this LogAnalyticsSourceLabelCondition. @@ -384,7 +384,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this LogAnalyticsSourceLabelCondition. - field internal name + The internal field name. :param field_name: The field_name of this LogAnalyticsSourceLabelCondition. @@ -396,7 +396,7 @@ def field_name(self, field_name): def label_condition_id(self): """ Gets the label_condition_id of this LogAnalyticsSourceLabelCondition. - Id + The unique identifier of the condition. :return: The label_condition_id of this LogAnalyticsSourceLabelCondition. @@ -408,7 +408,7 @@ def label_condition_id(self): def label_condition_id(self, label_condition_id): """ Sets the label_condition_id of this LogAnalyticsSourceLabelCondition. - Id + The unique identifier of the condition. :param label_condition_id: The label_condition_id of this LogAnalyticsSourceLabelCondition. @@ -420,7 +420,8 @@ def label_condition_id(self, label_condition_id): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceLabelCondition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceLabelCondition. @@ -432,7 +433,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceLabelCondition. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceLabelCondition. @@ -444,7 +446,7 @@ def is_system(self, is_system): def label_condition_operator(self): """ Gets the label_condition_operator of this LogAnalyticsSourceLabelCondition. - operator + The condition operator. :return: The label_condition_operator of this LogAnalyticsSourceLabelCondition. @@ -456,7 +458,7 @@ def label_condition_operator(self): def label_condition_operator(self, label_condition_operator): """ Sets the label_condition_operator of this LogAnalyticsSourceLabelCondition. - operator + The condition operator. :param label_condition_operator: The label_condition_operator of this LogAnalyticsSourceLabelCondition. @@ -468,7 +470,7 @@ def label_condition_operator(self, label_condition_operator): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceLabelCondition. - source Id + The unique identifier of the source. :return: The source_id of this LogAnalyticsSourceLabelCondition. @@ -480,7 +482,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceLabelCondition. - source Id + The unique identifier of the source. :param source_id: The source_id of this LogAnalyticsSourceLabelCondition. @@ -492,7 +494,7 @@ def source_id(self, source_id): def label_display_name(self): """ Gets the label_display_name of this LogAnalyticsSourceLabelCondition. - label display name + The label display name. :return: The label_display_name of this LogAnalyticsSourceLabelCondition. @@ -504,7 +506,7 @@ def label_display_name(self): def label_display_name(self, label_display_name): """ Sets the label_display_name of this LogAnalyticsSourceLabelCondition. - label display name + The label display name. :param label_display_name: The label_display_name of this LogAnalyticsSourceLabelCondition. @@ -516,7 +518,7 @@ def label_display_name(self, label_display_name): def storage_field(self): """ Gets the storage_field of this LogAnalyticsSourceLabelCondition. - label storage field + The label storage field. :return: The storage_field of this LogAnalyticsSourceLabelCondition. @@ -528,7 +530,7 @@ def storage_field(self): def storage_field(self, storage_field): """ Sets the storage_field of this LogAnalyticsSourceLabelCondition. - label storage field + The label storage field. :param storage_field: The storage_field of this LogAnalyticsSourceLabelCondition. @@ -540,7 +542,7 @@ def storage_field(self, storage_field): def label_name(self): """ Gets the label_name of this LogAnalyticsSourceLabelCondition. - label name + The label name. :return: The label_name of this LogAnalyticsSourceLabelCondition. @@ -552,7 +554,7 @@ def label_name(self): def label_name(self, label_name): """ Sets the label_name of this LogAnalyticsSourceLabelCondition. - label name + The label name. :param label_name: The label_name of this LogAnalyticsSourceLabelCondition. @@ -564,7 +566,7 @@ def label_name(self, label_name): def is_inline_label_existing_in_database(self): """ Gets the is_inline_label_existing_in_database of this LogAnalyticsSourceLabelCondition. - inline label exists in DB flag + A flag indicating whether or not the inline label exists in the database. :return: The is_inline_label_existing_in_database of this LogAnalyticsSourceLabelCondition. @@ -576,7 +578,7 @@ def is_inline_label_existing_in_database(self): def is_inline_label_existing_in_database(self, is_inline_label_existing_in_database): """ Sets the is_inline_label_existing_in_database of this LogAnalyticsSourceLabelCondition. - inline label exists in DB flag + A flag indicating whether or not the inline label exists in the database. :param is_inline_label_existing_in_database: The is_inline_label_existing_in_database of this LogAnalyticsSourceLabelCondition. diff --git a/src/oci/log_analytics/models/log_analytics_source_metadata_field.py b/src/oci/log_analytics/models/log_analytics_source_metadata_field.py index b20f2c1fc9..585d951433 100644 --- a/src/oci/log_analytics/models/log_analytics_source_metadata_field.py +++ b/src/oci/log_analytics/models/log_analytics_source_metadata_field.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def field_name(self): """ Gets the field_name of this LogAnalyticsSourceMetadataField. - field internal name + The field internal name. :return: The field_name of this LogAnalyticsSourceMetadataField. @@ -77,7 +77,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this LogAnalyticsSourceMetadataField. - field internal name + The field internal name. :param field_name: The field_name of this LogAnalyticsSourceMetadataField. @@ -89,7 +89,7 @@ def field_name(self, field_name): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourceMetadataField. - is enabled flag + A flag inidcating whether or not the source metadata field is enabled. :return: The is_enabled of this LogAnalyticsSourceMetadataField. @@ -101,7 +101,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourceMetadataField. - is enabled flag + A flag inidcating whether or not the source metadata field is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourceMetadataField. @@ -113,7 +113,8 @@ def is_enabled(self, is_enabled): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceMetadataField. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceMetadataField. @@ -125,7 +126,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceMetadataField. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceMetadataField. @@ -137,7 +139,7 @@ def is_system(self, is_system): def key(self): """ Gets the key of this LogAnalyticsSourceMetadataField. - key + The key. :return: The key of this LogAnalyticsSourceMetadataField. @@ -149,7 +151,7 @@ def key(self): def key(self, key): """ Sets the key of this LogAnalyticsSourceMetadataField. - key + The key. :param key: The key of this LogAnalyticsSourceMetadataField. @@ -161,7 +163,7 @@ def key(self, key): def source_name(self): """ Gets the source_name of this LogAnalyticsSourceMetadataField. - source internal name + The source internal name. :return: The source_name of this LogAnalyticsSourceMetadataField. @@ -173,7 +175,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this LogAnalyticsSourceMetadataField. - source internal name + The source internal name. :param source_name: The source_name of this LogAnalyticsSourceMetadataField. diff --git a/src/oci/log_analytics/models/log_analytics_source_metric.py b/src/oci/log_analytics/models/log_analytics_source_metric.py index 64f202d096..b86340c7f3 100644 --- a/src/oci/log_analytics/models/log_analytics_source_metric.py +++ b/src/oci/log_analytics/models/log_analytics_source_metric.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def is_metric_source_enabled(self): """ Gets the is_metric_source_enabled of this LogAnalyticsSourceMetric. - is enabled flag + A flag specifying whether or not the metric source is enabled. :return: The is_metric_source_enabled of this LogAnalyticsSourceMetric. @@ -70,7 +70,7 @@ def is_metric_source_enabled(self): def is_metric_source_enabled(self, is_metric_source_enabled): """ Sets the is_metric_source_enabled of this LogAnalyticsSourceMetric. - is enabled flag + A flag specifying whether or not the metric source is enabled. :param is_metric_source_enabled: The is_metric_source_enabled of this LogAnalyticsSourceMetric. @@ -82,7 +82,7 @@ def is_metric_source_enabled(self, is_metric_source_enabled): def metric_name(self): """ Gets the metric_name of this LogAnalyticsSourceMetric. - metric name + The metric name. :return: The metric_name of this LogAnalyticsSourceMetric. @@ -94,7 +94,7 @@ def metric_name(self): def metric_name(self, metric_name): """ Sets the metric_name of this LogAnalyticsSourceMetric. - metric name + The metric name. :param metric_name: The metric_name of this LogAnalyticsSourceMetric. @@ -106,7 +106,7 @@ def metric_name(self, metric_name): def source_name(self): """ Gets the source_name of this LogAnalyticsSourceMetric. - source internal name + The source internal name. :return: The source_name of this LogAnalyticsSourceMetric. @@ -118,7 +118,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this LogAnalyticsSourceMetric. - source internal name + The source internal name. :param source_name: The source_name of this LogAnalyticsSourceMetric. @@ -130,7 +130,7 @@ def source_name(self, source_name): def entity_type(self): """ Gets the entity_type of this LogAnalyticsSourceMetric. - entity type + The entity type. :return: The entity_type of this LogAnalyticsSourceMetric. @@ -142,7 +142,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsSourceMetric. - entity type + The entity type. :param entity_type: The entity_type of this LogAnalyticsSourceMetric. diff --git a/src/oci/log_analytics/models/log_analytics_source_pattern.py b/src/oci/log_analytics/models/log_analytics_source_pattern.py index a4ff74982e..3eb33cdac9 100644 --- a/src/oci/log_analytics/models/log_analytics_source_pattern.py +++ b/src/oci/log_analytics/models/log_analytics_source_pattern.py @@ -163,7 +163,7 @@ def __init__(self, **kwargs): def converted_text(self): """ Gets the converted_text of this LogAnalyticsSourcePattern. - converted text + The converted text. :return: The converted_text of this LogAnalyticsSourcePattern. @@ -175,7 +175,7 @@ def converted_text(self): def converted_text(self, converted_text): """ Sets the converted_text of this LogAnalyticsSourcePattern. - converted text + The converted text. :param converted_text: The converted_text of this LogAnalyticsSourcePattern. @@ -187,7 +187,7 @@ def converted_text(self, converted_text): def db_parser_id(self): """ Gets the db_parser_id of this LogAnalyticsSourcePattern. - parser Id + The parser unique identifier. :return: The db_parser_id of this LogAnalyticsSourcePattern. @@ -199,7 +199,7 @@ def db_parser_id(self): def db_parser_id(self, db_parser_id): """ Sets the db_parser_id of this LogAnalyticsSourcePattern. - parser Id + The parser unique identifier. :param db_parser_id: The db_parser_id of this LogAnalyticsSourcePattern. @@ -211,7 +211,7 @@ def db_parser_id(self, db_parser_id): def db_pattern_date_time_columns(self): """ Gets the db_pattern_date_time_columns of this LogAnalyticsSourcePattern. - date time columns + The date time columns. :return: The db_pattern_date_time_columns of this LogAnalyticsSourcePattern. @@ -223,7 +223,7 @@ def db_pattern_date_time_columns(self): def db_pattern_date_time_columns(self, db_pattern_date_time_columns): """ Sets the db_pattern_date_time_columns of this LogAnalyticsSourcePattern. - date time columns + The date time columns. :param db_pattern_date_time_columns: The db_pattern_date_time_columns of this LogAnalyticsSourcePattern. @@ -235,7 +235,7 @@ def db_pattern_date_time_columns(self, db_pattern_date_time_columns): def db_pattern_date_time_field(self): """ Gets the db_pattern_date_time_field of this LogAnalyticsSourcePattern. - date time field + The date time field. :return: The db_pattern_date_time_field of this LogAnalyticsSourcePattern. @@ -247,7 +247,7 @@ def db_pattern_date_time_field(self): def db_pattern_date_time_field(self, db_pattern_date_time_field): """ Sets the db_pattern_date_time_field of this LogAnalyticsSourcePattern. - date time field + The date time field. :param db_pattern_date_time_field: The db_pattern_date_time_field of this LogAnalyticsSourcePattern. @@ -259,7 +259,7 @@ def db_pattern_date_time_field(self, db_pattern_date_time_field): def db_pattern_sequence_column(self): """ Gets the db_pattern_sequence_column of this LogAnalyticsSourcePattern. - sequence column + The sequence column. :return: The db_pattern_sequence_column of this LogAnalyticsSourcePattern. @@ -271,7 +271,7 @@ def db_pattern_sequence_column(self): def db_pattern_sequence_column(self, db_pattern_sequence_column): """ Sets the db_pattern_sequence_column of this LogAnalyticsSourcePattern. - sequence column + The sequence column. :param db_pattern_sequence_column: The db_pattern_sequence_column of this LogAnalyticsSourcePattern. @@ -283,7 +283,7 @@ def db_pattern_sequence_column(self, db_pattern_sequence_column): def fields(self): """ Gets the fields of this LogAnalyticsSourcePattern. - field list + The parser field list. :return: The fields of this LogAnalyticsSourcePattern. @@ -295,7 +295,7 @@ def fields(self): def fields(self, fields): """ Sets the fields of this LogAnalyticsSourcePattern. - field list + The parser field list. :param fields: The fields of this LogAnalyticsSourcePattern. @@ -307,7 +307,7 @@ def fields(self, fields): def is_include(self): """ Gets the is_include of this LogAnalyticsSourcePattern. - is include flag + A flag indicating if this is source pattern is included. :return: The is_include of this LogAnalyticsSourcePattern. @@ -319,7 +319,7 @@ def is_include(self): def is_include(self, is_include): """ Sets the is_include of this LogAnalyticsSourcePattern. - is include flag + A flag indicating if this is source pattern is included. :param is_include: The is_include of this LogAnalyticsSourcePattern. @@ -331,7 +331,7 @@ def is_include(self, is_include): def is_default(self): """ Gets the is_default of this LogAnalyticsSourcePattern. - is default flag + A flag indicating if this is the default source pattern. :return: The is_default of this LogAnalyticsSourcePattern. @@ -343,7 +343,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this LogAnalyticsSourcePattern. - is default flag + A flag indicating if this is the default source pattern. :param is_default: The is_default of this LogAnalyticsSourcePattern. @@ -375,7 +375,7 @@ def pattern_filter(self, pattern_filter): def alias(self): """ Gets the alias of this LogAnalyticsSourcePattern. - alias + The source pattern alias. :return: The alias of this LogAnalyticsSourcePattern. @@ -387,7 +387,7 @@ def alias(self): def alias(self, alias): """ Sets the alias of this LogAnalyticsSourcePattern. - alias + The source pattern alias. :param alias: The alias of this LogAnalyticsSourcePattern. @@ -399,7 +399,7 @@ def alias(self, alias): def description(self): """ Gets the description of this LogAnalyticsSourcePattern. - description + The source pattern description. :return: The description of this LogAnalyticsSourcePattern. @@ -411,7 +411,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsSourcePattern. - description + The source pattern description. :param description: The description of this LogAnalyticsSourcePattern. @@ -423,7 +423,7 @@ def description(self, description): def is_enabled(self): """ Gets the is_enabled of this LogAnalyticsSourcePattern. - is enabled flag + A flag inidcating whether or not the source pattern is enabled. :return: The is_enabled of this LogAnalyticsSourcePattern. @@ -435,7 +435,7 @@ def is_enabled(self): def is_enabled(self, is_enabled): """ Sets the is_enabled of this LogAnalyticsSourcePattern. - is enabled flag + A flag inidcating whether or not the source pattern is enabled. :param is_enabled: The is_enabled of this LogAnalyticsSourcePattern. @@ -447,7 +447,7 @@ def is_enabled(self, is_enabled): def pattern_id(self): """ Gets the pattern_id of this LogAnalyticsSourcePattern. - pattern Id + The source pattern unique identifier. :return: The pattern_id of this LogAnalyticsSourcePattern. @@ -459,7 +459,7 @@ def pattern_id(self): def pattern_id(self, pattern_id): """ Sets the pattern_id of this LogAnalyticsSourcePattern. - pattern Id + The source pattern unique identifier. :param pattern_id: The pattern_id of this LogAnalyticsSourcePattern. @@ -471,7 +471,8 @@ def pattern_id(self, pattern_id): def is_system(self): """ Gets the is_system of this LogAnalyticsSourcePattern. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourcePattern. @@ -483,7 +484,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourcePattern. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourcePattern. @@ -495,7 +497,7 @@ def is_system(self, is_system): def source_id(self): """ Gets the source_id of this LogAnalyticsSourcePattern. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourcePattern. @@ -507,7 +509,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourcePattern. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourcePattern. @@ -519,7 +521,8 @@ def source_id(self, source_id): def is_agent_warning_suppressed(self): """ Gets the is_agent_warning_suppressed of this LogAnalyticsSourcePattern. - suppress agent warning + A flag indicating whether or not agent warnings are suppressed for + this source pattern. :return: The is_agent_warning_suppressed of this LogAnalyticsSourcePattern. @@ -531,7 +534,8 @@ def is_agent_warning_suppressed(self): def is_agent_warning_suppressed(self, is_agent_warning_suppressed): """ Sets the is_agent_warning_suppressed of this LogAnalyticsSourcePattern. - suppress agent warning + A flag indicating whether or not agent warnings are suppressed for + this source pattern. :param is_agent_warning_suppressed: The is_agent_warning_suppressed of this LogAnalyticsSourcePattern. @@ -543,7 +547,7 @@ def is_agent_warning_suppressed(self, is_agent_warning_suppressed): def pattern_text(self): """ Gets the pattern_text of this LogAnalyticsSourcePattern. - pattern text + The pattern text. :return: The pattern_text of this LogAnalyticsSourcePattern. @@ -555,7 +559,7 @@ def pattern_text(self): def pattern_text(self, pattern_text): """ Sets the pattern_text of this LogAnalyticsSourcePattern. - pattern text + The pattern text. :param pattern_text: The pattern_text of this LogAnalyticsSourcePattern. @@ -567,7 +571,7 @@ def pattern_text(self, pattern_text): def pattern_type(self): """ Gets the pattern_type of this LogAnalyticsSourcePattern. - pattern type + The pattern type. :return: The pattern_type of this LogAnalyticsSourcePattern. @@ -579,7 +583,7 @@ def pattern_type(self): def pattern_type(self, pattern_type): """ Sets the pattern_type of this LogAnalyticsSourcePattern. - pattern type + The pattern type. :param pattern_type: The pattern_type of this LogAnalyticsSourcePattern. @@ -591,7 +595,7 @@ def pattern_type(self, pattern_type): def entity_type(self): """ Gets the entity_type of this LogAnalyticsSourcePattern. - source entity types + The source entity type. :return: The entity_type of this LogAnalyticsSourcePattern. @@ -603,7 +607,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this LogAnalyticsSourcePattern. - source entity types + The source entity type. :param entity_type: The entity_type of this LogAnalyticsSourcePattern. diff --git a/src/oci/log_analytics/models/log_analytics_source_pattern_collection.py b/src/oci/log_analytics/models/log_analytics_source_pattern_collection.py index e2f9b6fb0c..709f6cda7e 100644 --- a/src/oci/log_analytics/models/log_analytics_source_pattern_collection.py +++ b/src/oci/log_analytics/models/log_analytics_source_pattern_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this LogAnalyticsSourcePatternCollection. - list of source patterns + An array of source patterns. :return: The items of this LogAnalyticsSourcePatternCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this LogAnalyticsSourcePatternCollection. - list of source patterns + An array of source patterns. :param items: The items of this LogAnalyticsSourcePatternCollection. diff --git a/src/oci/log_analytics/models/log_analytics_source_summary.py b/src/oci/log_analytics/models/log_analytics_source_summary.py index 6cad9f69e2..0b30b629b4 100644 --- a/src/oci/log_analytics/models/log_analytics_source_summary.py +++ b/src/oci/log_analytics/models/log_analytics_source_summary.py @@ -275,7 +275,7 @@ def __init__(self, **kwargs): def label_conditions(self): """ Gets the label_conditions of this LogAnalyticsSourceSummary. - alert conditions + The label alert conditions. :return: The label_conditions of this LogAnalyticsSourceSummary. @@ -287,7 +287,7 @@ def label_conditions(self): def label_conditions(self, label_conditions): """ Sets the label_conditions of this LogAnalyticsSourceSummary. - alert conditions + The label alert conditions. :param label_conditions: The label_conditions of this LogAnalyticsSourceSummary. @@ -299,7 +299,7 @@ def label_conditions(self, label_conditions): def association_count(self): """ Gets the association_count of this LogAnalyticsSourceSummary. - association count + The association count. :return: The association_count of this LogAnalyticsSourceSummary. @@ -311,7 +311,7 @@ def association_count(self): def association_count(self, association_count): """ Sets the association_count of this LogAnalyticsSourceSummary. - association count + The association count. :param association_count: The association_count of this LogAnalyticsSourceSummary. @@ -323,7 +323,7 @@ def association_count(self, association_count): def association_entity(self): """ Gets the association_entity of this LogAnalyticsSourceSummary. - association entity + The association entity. :return: The association_entity of this LogAnalyticsSourceSummary. @@ -335,7 +335,7 @@ def association_entity(self): def association_entity(self, association_entity): """ Sets the association_entity of this LogAnalyticsSourceSummary. - association entity + The association entity. :param association_entity: The association_entity of this LogAnalyticsSourceSummary. @@ -347,7 +347,7 @@ def association_entity(self, association_entity): def data_filter_definitions(self): """ Gets the data_filter_definitions of this LogAnalyticsSourceSummary. - data filter definitions + The data filter definition. :return: The data_filter_definitions of this LogAnalyticsSourceSummary. @@ -359,7 +359,7 @@ def data_filter_definitions(self): def data_filter_definitions(self, data_filter_definitions): """ Sets the data_filter_definitions of this LogAnalyticsSourceSummary. - data filter definitions + The data filter definition. :param data_filter_definitions: The data_filter_definitions of this LogAnalyticsSourceSummary. @@ -371,7 +371,7 @@ def data_filter_definitions(self, data_filter_definitions): def database_credential(self): """ Gets the database_credential of this LogAnalyticsSourceSummary. - DB credential + The database credential. :return: The database_credential of this LogAnalyticsSourceSummary. @@ -383,7 +383,7 @@ def database_credential(self): def database_credential(self, database_credential): """ Sets the database_credential of this LogAnalyticsSourceSummary. - DB credential + The database credential. :param database_credential: The database_credential of this LogAnalyticsSourceSummary. @@ -395,7 +395,7 @@ def database_credential(self, database_credential): def extended_field_definitions(self): """ Gets the extended_field_definitions of this LogAnalyticsSourceSummary. - extended field definition + The extended field definition. :return: The extended_field_definitions of this LogAnalyticsSourceSummary. @@ -407,7 +407,7 @@ def extended_field_definitions(self): def extended_field_definitions(self, extended_field_definitions): """ Sets the extended_field_definitions of this LogAnalyticsSourceSummary. - extended field definition + The extended field definition. :param extended_field_definitions: The extended_field_definitions of this LogAnalyticsSourceSummary. @@ -419,7 +419,7 @@ def extended_field_definitions(self, extended_field_definitions): def is_for_cloud(self): """ Gets the is_for_cloud of this LogAnalyticsSourceSummary. - is for cloud flag + A flag indicating whether or not this is a cloud source. :return: The is_for_cloud of this LogAnalyticsSourceSummary. @@ -431,7 +431,7 @@ def is_for_cloud(self): def is_for_cloud(self, is_for_cloud): """ Sets the is_for_cloud of this LogAnalyticsSourceSummary. - is for cloud flag + A flag indicating whether or not this is a cloud source. :param is_for_cloud: The is_for_cloud of this LogAnalyticsSourceSummary. @@ -443,7 +443,7 @@ def is_for_cloud(self, is_for_cloud): def labels(self): """ Gets the labels of this LogAnalyticsSourceSummary. - labels + The labels associated with this source. :return: The labels of this LogAnalyticsSourceSummary. @@ -455,7 +455,7 @@ def labels(self): def labels(self, labels): """ Sets the labels of this LogAnalyticsSourceSummary. - labels + The labels associated with this source. :param labels: The labels of this LogAnalyticsSourceSummary. @@ -467,7 +467,7 @@ def labels(self, labels): def metric_definitions(self): """ Gets the metric_definitions of this LogAnalyticsSourceSummary. - metric definitions + The metric definitions. :return: The metric_definitions of this LogAnalyticsSourceSummary. @@ -479,7 +479,7 @@ def metric_definitions(self): def metric_definitions(self, metric_definitions): """ Sets the metric_definitions of this LogAnalyticsSourceSummary. - metric definitions + The metric definitions. :param metric_definitions: The metric_definitions of this LogAnalyticsSourceSummary. @@ -491,7 +491,7 @@ def metric_definitions(self, metric_definitions): def metrics(self): """ Gets the metrics of this LogAnalyticsSourceSummary. - metric source map + The metric source map. :return: The metrics of this LogAnalyticsSourceSummary. @@ -503,7 +503,7 @@ def metrics(self): def metrics(self, metrics): """ Sets the metrics of this LogAnalyticsSourceSummary. - metric source map + The metric source map. :param metrics: The metrics of this LogAnalyticsSourceSummary. @@ -515,7 +515,7 @@ def metrics(self, metrics): def oob_parsers(self): """ Gets the oob_parsers of this LogAnalyticsSourceSummary. - out-of-the-box source parser list + The built in source parser. :return: The oob_parsers of this LogAnalyticsSourceSummary. @@ -527,7 +527,7 @@ def oob_parsers(self): def oob_parsers(self, oob_parsers): """ Sets the oob_parsers of this LogAnalyticsSourceSummary. - out-of-the-box source parser list + The built in source parser. :param oob_parsers: The oob_parsers of this LogAnalyticsSourceSummary. @@ -539,7 +539,7 @@ def oob_parsers(self, oob_parsers): def parameters(self): """ Gets the parameters of this LogAnalyticsSourceSummary. - parameters + The parameter. :return: The parameters of this LogAnalyticsSourceSummary. @@ -551,7 +551,7 @@ def parameters(self): def parameters(self, parameters): """ Sets the parameters of this LogAnalyticsSourceSummary. - parameters + The parameter. :param parameters: The parameters of this LogAnalyticsSourceSummary. @@ -563,7 +563,7 @@ def parameters(self, parameters): def pattern_count(self): """ Gets the pattern_count of this LogAnalyticsSourceSummary. - pattern count + The pattern count. :return: The pattern_count of this LogAnalyticsSourceSummary. @@ -575,7 +575,7 @@ def pattern_count(self): def pattern_count(self, pattern_count): """ Sets the pattern_count of this LogAnalyticsSourceSummary. - pattern count + The pattern count. :param pattern_count: The pattern_count of this LogAnalyticsSourceSummary. @@ -587,7 +587,7 @@ def pattern_count(self, pattern_count): def patterns(self): """ Gets the patterns of this LogAnalyticsSourceSummary. - patterns + The source patterns. :return: The patterns of this LogAnalyticsSourceSummary. @@ -599,7 +599,7 @@ def patterns(self): def patterns(self, patterns): """ Sets the patterns of this LogAnalyticsSourceSummary. - patterns + The source patterns. :param patterns: The patterns of this LogAnalyticsSourceSummary. @@ -611,7 +611,7 @@ def patterns(self, patterns): def description(self): """ Gets the description of this LogAnalyticsSourceSummary. - description + The source description. :return: The description of this LogAnalyticsSourceSummary. @@ -623,7 +623,7 @@ def description(self): def description(self, description): """ Sets the description of this LogAnalyticsSourceSummary. - description + The source description. :param description: The description of this LogAnalyticsSourceSummary. @@ -635,7 +635,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this LogAnalyticsSourceSummary. - display name + The source display name. :return: The display_name of this LogAnalyticsSourceSummary. @@ -647,7 +647,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LogAnalyticsSourceSummary. - display name + The source display name. :param display_name: The display_name of this LogAnalyticsSourceSummary. @@ -659,7 +659,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this LogAnalyticsSourceSummary. - source edit version + The source edit version. :return: The edit_version of this LogAnalyticsSourceSummary. @@ -671,7 +671,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this LogAnalyticsSourceSummary. - source edit version + The source edit version. :param edit_version: The edit_version of this LogAnalyticsSourceSummary. @@ -683,7 +683,7 @@ def edit_version(self, edit_version): def functions(self): """ Gets the functions of this LogAnalyticsSourceSummary. - source functions + The source functions. :return: The functions of this LogAnalyticsSourceSummary. @@ -695,7 +695,7 @@ def functions(self): def functions(self, functions): """ Sets the functions of this LogAnalyticsSourceSummary. - source functions + The source functions. :param functions: The functions of this LogAnalyticsSourceSummary. @@ -707,7 +707,7 @@ def functions(self, functions): def source_id(self): """ Gets the source_id of this LogAnalyticsSourceSummary. - source Id + The source unique identifier. :return: The source_id of this LogAnalyticsSourceSummary. @@ -719,7 +719,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this LogAnalyticsSourceSummary. - source Id + The source unique identifier. :param source_id: The source_id of this LogAnalyticsSourceSummary. @@ -731,7 +731,7 @@ def source_id(self, source_id): def name(self): """ Gets the name of this LogAnalyticsSourceSummary. - source internal name + The source internal name. :return: The name of this LogAnalyticsSourceSummary. @@ -743,7 +743,7 @@ def name(self): def name(self, name): """ Sets the name of this LogAnalyticsSourceSummary. - source internal name + The source internal name. :param name: The name of this LogAnalyticsSourceSummary. @@ -755,7 +755,7 @@ def name(self, name): def is_secure_content(self): """ Gets the is_secure_content of this LogAnalyticsSourceSummary. - is secure content flag + A flag indicating whether or not the source content is secure. :return: The is_secure_content of this LogAnalyticsSourceSummary. @@ -767,7 +767,7 @@ def is_secure_content(self): def is_secure_content(self, is_secure_content): """ Sets the is_secure_content of this LogAnalyticsSourceSummary. - is secure content flag + A flag indicating whether or not the source content is secure. :param is_secure_content: The is_secure_content of this LogAnalyticsSourceSummary. @@ -779,7 +779,8 @@ def is_secure_content(self, is_secure_content): def is_system(self): """ Gets the is_system of this LogAnalyticsSourceSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this LogAnalyticsSourceSummary. @@ -791,7 +792,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this LogAnalyticsSourceSummary. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this LogAnalyticsSourceSummary. @@ -803,7 +805,7 @@ def is_system(self, is_system): def parsers(self): """ Gets the parsers of this LogAnalyticsSourceSummary. - parser list + The list of parsers associated with this source. :return: The parsers of this LogAnalyticsSourceSummary. @@ -815,7 +817,7 @@ def parsers(self): def parsers(self, parsers): """ Sets the parsers of this LogAnalyticsSourceSummary. - parser list + The list of parsers associated with this source. :param parsers: The parsers of this LogAnalyticsSourceSummary. @@ -827,7 +829,7 @@ def parsers(self, parsers): def is_auto_association_enabled(self): """ Gets the is_auto_association_enabled of this LogAnalyticsSourceSummary. - rule auto association enabled flag + A flag indicating whether or not the source is marked for auto-association. :return: The is_auto_association_enabled of this LogAnalyticsSourceSummary. @@ -839,7 +841,7 @@ def is_auto_association_enabled(self): def is_auto_association_enabled(self, is_auto_association_enabled): """ Sets the is_auto_association_enabled of this LogAnalyticsSourceSummary. - rule auto association enabled flag + A flag indicating whether or not the source is marked for auto-association. :param is_auto_association_enabled: The is_auto_association_enabled of this LogAnalyticsSourceSummary. @@ -851,7 +853,7 @@ def is_auto_association_enabled(self, is_auto_association_enabled): def is_auto_association_override(self): """ Gets the is_auto_association_override of this LogAnalyticsSourceSummary. - rule auto association override + A flag indicating whether or not the auto-association state should be overriden. :return: The is_auto_association_override of this LogAnalyticsSourceSummary. @@ -863,7 +865,7 @@ def is_auto_association_override(self): def is_auto_association_override(self, is_auto_association_override): """ Sets the is_auto_association_override of this LogAnalyticsSourceSummary. - rule auto association override + A flag indicating whether or not the auto-association state should be overriden. :param is_auto_association_override: The is_auto_association_override of this LogAnalyticsSourceSummary. @@ -875,7 +877,7 @@ def is_auto_association_override(self, is_auto_association_override): def rule_id(self): """ Gets the rule_id of this LogAnalyticsSourceSummary. - rule Id + The rule unique identifier. :return: The rule_id of this LogAnalyticsSourceSummary. @@ -887,7 +889,7 @@ def rule_id(self): def rule_id(self, rule_id): """ Sets the rule_id of this LogAnalyticsSourceSummary. - rule Id + The rule unique identifier. :param rule_id: The rule_id of this LogAnalyticsSourceSummary. @@ -899,7 +901,7 @@ def rule_id(self, rule_id): def type_name(self): """ Gets the type_name of this LogAnalyticsSourceSummary. - source type internal name + The source type internal name. :return: The type_name of this LogAnalyticsSourceSummary. @@ -911,7 +913,7 @@ def type_name(self): def type_name(self, type_name): """ Sets the type_name of this LogAnalyticsSourceSummary. - source type internal name + The source type internal name. :param type_name: The type_name of this LogAnalyticsSourceSummary. @@ -923,7 +925,7 @@ def type_name(self, type_name): def type_display_name(self): """ Gets the type_display_name of this LogAnalyticsSourceSummary. - source type name + The source type name. :return: The type_display_name of this LogAnalyticsSourceSummary. @@ -935,7 +937,7 @@ def type_display_name(self): def type_display_name(self, type_display_name): """ Sets the type_display_name of this LogAnalyticsSourceSummary. - source type name + The source type name. :param type_display_name: The type_display_name of this LogAnalyticsSourceSummary. @@ -947,7 +949,7 @@ def type_display_name(self, type_display_name): def warning_config(self): """ Gets the warning_config of this LogAnalyticsSourceSummary. - source warning configuration + The source warning configuration. :return: The warning_config of this LogAnalyticsSourceSummary. @@ -959,7 +961,7 @@ def warning_config(self): def warning_config(self, warning_config): """ Sets the warning_config of this LogAnalyticsSourceSummary. - source warning configuration + The source warning configuration. :param warning_config: The warning_config of this LogAnalyticsSourceSummary. @@ -971,7 +973,7 @@ def warning_config(self, warning_config): def metadata_fields(self): """ Gets the metadata_fields of this LogAnalyticsSourceSummary. - source metadata fields + The source metadata fields. :return: The metadata_fields of this LogAnalyticsSourceSummary. @@ -983,7 +985,7 @@ def metadata_fields(self): def metadata_fields(self, metadata_fields): """ Sets the metadata_fields of this LogAnalyticsSourceSummary. - source metadata fields + The source metadata fields. :param metadata_fields: The metadata_fields of this LogAnalyticsSourceSummary. @@ -995,7 +997,7 @@ def metadata_fields(self, metadata_fields): def label_definitions(self): """ Gets the label_definitions of this LogAnalyticsSourceSummary. - tags + The label definitions. :return: The label_definitions of this LogAnalyticsSourceSummary. @@ -1007,7 +1009,7 @@ def label_definitions(self): def label_definitions(self, label_definitions): """ Sets the label_definitions of this LogAnalyticsSourceSummary. - tags + The label definitions. :param label_definitions: The label_definitions of this LogAnalyticsSourceSummary. @@ -1019,7 +1021,7 @@ def label_definitions(self, label_definitions): def entity_types(self): """ Gets the entity_types of this LogAnalyticsSourceSummary. - Entity types + The entity types. :return: The entity_types of this LogAnalyticsSourceSummary. @@ -1031,7 +1033,7 @@ def entity_types(self): def entity_types(self, entity_types): """ Sets the entity_types of this LogAnalyticsSourceSummary. - Entity types + The entity types. :param entity_types: The entity_types of this LogAnalyticsSourceSummary. @@ -1043,7 +1045,7 @@ def entity_types(self, entity_types): def is_timezone_override(self): """ Gets the is_timezone_override of this LogAnalyticsSourceSummary. - time zone override + A flag indicating whether or not the source has a time zone override. :return: The is_timezone_override of this LogAnalyticsSourceSummary. @@ -1055,7 +1057,7 @@ def is_timezone_override(self): def is_timezone_override(self, is_timezone_override): """ Sets the is_timezone_override of this LogAnalyticsSourceSummary. - time zone override + A flag indicating whether or not the source has a time zone override. :param is_timezone_override: The is_timezone_override of this LogAnalyticsSourceSummary. @@ -1067,7 +1069,7 @@ def is_timezone_override(self, is_timezone_override): def user_parsers(self): """ Gets the user_parsers of this LogAnalyticsSourceSummary. - source parser list + An array of custom parsers. :return: The user_parsers of this LogAnalyticsSourceSummary. @@ -1079,7 +1081,7 @@ def user_parsers(self): def user_parsers(self, user_parsers): """ Sets the user_parsers of this LogAnalyticsSourceSummary. - source parser list + An array of custom parsers. :param user_parsers: The user_parsers of this LogAnalyticsSourceSummary. @@ -1091,7 +1093,7 @@ def user_parsers(self, user_parsers): def time_updated(self): """ Gets the time_updated of this LogAnalyticsSourceSummary. - timeUpdated + The last updated date. :return: The time_updated of this LogAnalyticsSourceSummary. @@ -1103,7 +1105,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this LogAnalyticsSourceSummary. - timeUpdated + The last updated date. :param time_updated: The time_updated of this LogAnalyticsSourceSummary. diff --git a/src/oci/log_analytics/models/log_group_summary_report.py b/src/oci/log_analytics/models/log_group_summary_report.py index bd7f0db7d2..267dcd02f7 100644 --- a/src/oci/log_analytics/models/log_group_summary_report.py +++ b/src/oci/log_analytics/models/log_group_summary_report.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class LogGroupSummaryReport(object): """ - LogGroupSummaryReport + A LogAnalytics Log Group summary report. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def count(self): """ Gets the count of this LogGroupSummaryReport. - log group count + The log group count. :return: The count of this LogGroupSummaryReport. @@ -49,7 +49,7 @@ def count(self): def count(self, count): """ Sets the count of this LogGroupSummaryReport. - log group count + The log group count. :param count: The count of this LogGroupSummaryReport. diff --git a/src/oci/log_analytics/models/log_set_collection.py b/src/oci/log_analytics/models/log_set_collection.py new file mode 100644 index 0000000000..74a6e917f5 --- /dev/null +++ b/src/oci/log_analytics/models/log_set_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LogSetCollection(object): + """ + It contains a list of log sets + """ + + def __init__(self, **kwargs): + """ + Initializes a new LogSetCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this LogSetCollection. + :type items: list[str] + + """ + self.swagger_types = { + 'items': 'list[str]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this LogSetCollection. + This is the array of log sets + + + :return: The items of this LogSetCollection. + :rtype: list[str] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this LogSetCollection. + This is the array of log sets + + + :param items: The items of this LogSetCollection. + :type: list[str] + """ + self._items = items + + 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/log_analytics/models/lookup_field.py b/src/oci/log_analytics/models/lookup_field.py index c1cb718a90..4e028e0028 100644 --- a/src/oci/log_analytics/models/lookup_field.py +++ b/src/oci/log_analytics/models/lookup_field.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def common_field_name(self): """ Gets the common_field_name of this LookupField. - common field name + The common field name. :return: The common_field_name of this LookupField. @@ -91,7 +91,7 @@ def common_field_name(self): def common_field_name(self, common_field_name): """ Sets the common_field_name of this LookupField. - common field name + The common field name. :param common_field_name: The common_field_name of this LookupField. @@ -103,7 +103,7 @@ def common_field_name(self, common_field_name): def default_match_value(self): """ Gets the default_match_value of this LookupField. - default match value + The default match value. :return: The default_match_value of this LookupField. @@ -115,7 +115,7 @@ def default_match_value(self): def default_match_value(self, default_match_value): """ Sets the default_match_value of this LookupField. - default match value + The default match value. :param default_match_value: The default_match_value of this LookupField. @@ -127,7 +127,7 @@ def default_match_value(self, default_match_value): def display_name(self): """ Gets the display_name of this LookupField. - display name + The field display name. :return: The display_name of this LookupField. @@ -139,7 +139,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LookupField. - display name + The field display name. :param display_name: The display_name of this LookupField. @@ -151,7 +151,7 @@ def display_name(self, display_name): def is_common_field(self): """ Gets the is_common_field of this LookupField. - is common field + A flag indicating whether or not the lookup field is a common field. :return: The is_common_field of this LookupField. @@ -163,7 +163,7 @@ def is_common_field(self): def is_common_field(self, is_common_field): """ Sets the is_common_field of this LookupField. - is common field + A flag indicating whether or not the lookup field is a common field. :param is_common_field: The is_common_field of this LookupField. @@ -175,7 +175,7 @@ def is_common_field(self, is_common_field): def match_operator(self): """ Gets the match_operator of this LookupField. - match operator + The match operator. :return: The match_operator of this LookupField. @@ -187,7 +187,7 @@ def match_operator(self): def match_operator(self, match_operator): """ Sets the match_operator of this LookupField. - match operator + The match operator. :param match_operator: The match_operator of this LookupField. @@ -199,7 +199,7 @@ def match_operator(self, match_operator): def name(self): """ Gets the name of this LookupField. - name + The field name. :return: The name of this LookupField. @@ -211,7 +211,7 @@ def name(self): def name(self, name): """ Sets the name of this LookupField. - name + The field name. :param name: The name of this LookupField. @@ -223,7 +223,7 @@ def name(self, name): def position(self): """ Gets the position of this LookupField. - position + THe field position. :return: The position of this LookupField. @@ -235,7 +235,7 @@ def position(self): def position(self, position): """ Sets the position of this LookupField. - position + THe field position. :param position: The position of this LookupField. diff --git a/src/oci/log_analytics/models/lookup_summary_report.py b/src/oci/log_analytics/models/lookup_summary_report.py new file mode 100644 index 0000000000..6bb82d1e94 --- /dev/null +++ b/src/oci/log_analytics/models/lookup_summary_report.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LookupSummaryReport(object): + """ + Summary report of lookups in the tenancy. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LookupSummaryReport object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param user_created_count: + The value to assign to the user_created_count property of this LookupSummaryReport. + :type user_created_count: int + + :param oracle_defined_count: + The value to assign to the oracle_defined_count property of this LookupSummaryReport. + :type oracle_defined_count: int + + :param total_count: + The value to assign to the total_count property of this LookupSummaryReport. + :type total_count: int + + """ + self.swagger_types = { + 'user_created_count': 'int', + 'oracle_defined_count': 'int', + 'total_count': 'int' + } + + self.attribute_map = { + 'user_created_count': 'userCreatedCount', + 'oracle_defined_count': 'oracleDefinedCount', + 'total_count': 'totalCount' + } + + self._user_created_count = None + self._oracle_defined_count = None + self._total_count = None + + @property + def user_created_count(self): + """ + Gets the user_created_count of this LookupSummaryReport. + The number of user created lookups. + + + :return: The user_created_count of this LookupSummaryReport. + :rtype: int + """ + return self._user_created_count + + @user_created_count.setter + def user_created_count(self, user_created_count): + """ + Sets the user_created_count of this LookupSummaryReport. + The number of user created lookups. + + + :param user_created_count: The user_created_count of this LookupSummaryReport. + :type: int + """ + self._user_created_count = user_created_count + + @property + def oracle_defined_count(self): + """ + Gets the oracle_defined_count of this LookupSummaryReport. + The number of oracle defined lookups. + + + :return: The oracle_defined_count of this LookupSummaryReport. + :rtype: int + """ + return self._oracle_defined_count + + @oracle_defined_count.setter + def oracle_defined_count(self, oracle_defined_count): + """ + Sets the oracle_defined_count of this LookupSummaryReport. + The number of oracle defined lookups. + + + :param oracle_defined_count: The oracle_defined_count of this LookupSummaryReport. + :type: int + """ + self._oracle_defined_count = oracle_defined_count + + @property + def total_count(self): + """ + Gets the total_count of this LookupSummaryReport. + The total number of lookups. + + + :return: The total_count of this LookupSummaryReport. + :rtype: int + """ + return self._total_count + + @total_count.setter + def total_count(self, total_count): + """ + Sets the total_count of this LookupSummaryReport. + The total number of lookups. + + + :param total_count: The total_count of this LookupSummaryReport. + :type: int + """ + self._total_count = total_count + + 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/log_analytics/models/match_info.py b/src/oci/log_analytics/models/match_info.py index 3e2b1e1168..8d4196225d 100644 --- a/src/oci/log_analytics/models/match_info.py +++ b/src/oci/log_analytics/models/match_info.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def matching_log_entry_end_index(self): """ Gets the matching_log_entry_end_index of this MatchInfo. - matchingLogEntryEndIndex + The end index of the matching log entry. :return: The matching_log_entry_end_index of this MatchInfo. @@ -63,7 +63,7 @@ def matching_log_entry_end_index(self): def matching_log_entry_end_index(self, matching_log_entry_end_index): """ Sets the matching_log_entry_end_index of this MatchInfo. - matchingLogEntryEndIndex + The end index of the matching log entry. :param matching_log_entry_end_index: The matching_log_entry_end_index of this MatchInfo. @@ -75,7 +75,7 @@ def matching_log_entry_end_index(self, matching_log_entry_end_index): def regex_score(self): """ Gets the regex_score of this MatchInfo. - regexScore + The regular expression score. :return: The regex_score of this MatchInfo. @@ -87,7 +87,7 @@ def regex_score(self): def regex_score(self, regex_score): """ Sets the regex_score of this MatchInfo. - regexScore + The regular expression score. :param regex_score: The regex_score of this MatchInfo. @@ -99,7 +99,7 @@ def regex_score(self, regex_score): def step_count(self): """ Gets the step_count of this MatchInfo. - stepCount + The step count. :return: The step_count of this MatchInfo. @@ -111,7 +111,7 @@ def step_count(self): def step_count(self, step_count): """ Sets the step_count of this MatchInfo. - stepCount + The step count. :param step_count: The step_count of this MatchInfo. diff --git a/src/oci/log_analytics/models/namespace.py b/src/oci/log_analytics/models/namespace.py index 59bdb3ae36..f2199b134b 100644 --- a/src/oci/log_analytics/models/namespace.py +++ b/src/oci/log_analytics/models/namespace.py @@ -30,22 +30,29 @@ def __init__(self, **kwargs): The value to assign to the is_onboarded property of this Namespace. :type is_onboarded: bool + :param is_log_set_enabled: + The value to assign to the is_log_set_enabled property of this Namespace. + :type is_log_set_enabled: bool + """ self.swagger_types = { 'namespace_name': 'str', 'compartment_id': 'str', - 'is_onboarded': 'bool' + 'is_onboarded': 'bool', + 'is_log_set_enabled': 'bool' } self.attribute_map = { 'namespace_name': 'namespaceName', 'compartment_id': 'compartmentId', - 'is_onboarded': 'isOnboarded' + 'is_onboarded': 'isOnboarded', + 'is_log_set_enabled': 'isLogSetEnabled' } self._namespace_name = None self._compartment_id = None self._is_onboarded = None + self._is_log_set_enabled = None @property def namespace_name(self): @@ -119,6 +126,30 @@ def is_onboarded(self, is_onboarded): """ self._is_onboarded = is_onboarded + @property + def is_log_set_enabled(self): + """ + Gets the is_log_set_enabled of this Namespace. + This indicates if the log set feature is enabled for the tenancy + + + :return: The is_log_set_enabled of this Namespace. + :rtype: bool + """ + return self._is_log_set_enabled + + @is_log_set_enabled.setter + def is_log_set_enabled(self, is_log_set_enabled): + """ + Sets the is_log_set_enabled of this Namespace. + This indicates if the log set feature is enabled for the tenancy + + + :param is_log_set_enabled: The is_log_set_enabled of this Namespace. + :type: bool + """ + self._is_log_set_enabled = is_log_set_enabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/namespace_summary.py b/src/oci/log_analytics/models/namespace_summary.py index 80df068c50..6aa3b8da84 100644 --- a/src/oci/log_analytics/models/namespace_summary.py +++ b/src/oci/log_analytics/models/namespace_summary.py @@ -30,22 +30,29 @@ def __init__(self, **kwargs): The value to assign to the is_onboarded property of this NamespaceSummary. :type is_onboarded: bool + :param is_log_set_enabled: + The value to assign to the is_log_set_enabled property of this NamespaceSummary. + :type is_log_set_enabled: bool + """ self.swagger_types = { 'namespace_name': 'str', 'compartment_id': 'str', - 'is_onboarded': 'bool' + 'is_onboarded': 'bool', + 'is_log_set_enabled': 'bool' } self.attribute_map = { 'namespace_name': 'namespaceName', 'compartment_id': 'compartmentId', - 'is_onboarded': 'isOnboarded' + 'is_onboarded': 'isOnboarded', + 'is_log_set_enabled': 'isLogSetEnabled' } self._namespace_name = None self._compartment_id = None self._is_onboarded = None + self._is_log_set_enabled = None @property def namespace_name(self): @@ -119,6 +126,30 @@ def is_onboarded(self, is_onboarded): """ self._is_onboarded = is_onboarded + @property + def is_log_set_enabled(self): + """ + Gets the is_log_set_enabled of this NamespaceSummary. + This indicates if the log set feature is enabled for the tenancy + + + :return: The is_log_set_enabled of this NamespaceSummary. + :rtype: bool + """ + return self._is_log_set_enabled + + @is_log_set_enabled.setter + def is_log_set_enabled(self, is_log_set_enabled): + """ + Sets the is_log_set_enabled of this NamespaceSummary. + This indicates if the log set feature is enabled for the tenancy + + + :param is_log_set_enabled: The is_log_set_enabled of this NamespaceSummary. + :type: bool + """ + self._is_log_set_enabled = is_log_set_enabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/log_analytics/models/parser_summary_report.py b/src/oci/log_analytics/models/parser_summary_report.py index 1f92ab24ac..8913809428 100644 --- a/src/oci/log_analytics/models/parser_summary_report.py +++ b/src/oci/log_analytics/models/parser_summary_report.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def non_oob_count(self): """ Gets the non_oob_count of this ParserSummaryReport. - non out-of-the-box count + The count of custom (user defined) parsers. :return: The non_oob_count of this ParserSummaryReport. @@ -56,7 +56,7 @@ def non_oob_count(self): def non_oob_count(self, non_oob_count): """ Sets the non_oob_count of this ParserSummaryReport. - non out-of-the-box count + The count of custom (user defined) parsers. :param non_oob_count: The non_oob_count of this ParserSummaryReport. @@ -68,7 +68,7 @@ def non_oob_count(self, non_oob_count): def oob_count(self): """ Gets the oob_count of this ParserSummaryReport. - out-of-the-box count + The count of built in parsers. :return: The oob_count of this ParserSummaryReport. @@ -80,7 +80,7 @@ def oob_count(self): def oob_count(self, oob_count): """ Sets the oob_count of this ParserSummaryReport. - out-of-the-box count + The count of built in parsers. :param oob_count: The oob_count of this ParserSummaryReport. diff --git a/src/oci/log_analytics/models/parser_test_result.py b/src/oci/log_analytics/models/parser_test_result.py index 989f7b3c69..f71622aea7 100644 --- a/src/oci/log_analytics/models/parser_test_result.py +++ b/src/oci/log_analytics/models/parser_test_result.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def additional_info(self): """ Gets the additional_info of this ParserTestResult. - additional info + Additional information for the test result. :return: The additional_info of this ParserTestResult. @@ -77,7 +77,7 @@ def additional_info(self): def additional_info(self, additional_info): """ Sets the additional_info of this ParserTestResult. - additional info + Additional information for the test result. :param additional_info: The additional_info of this ParserTestResult. @@ -89,7 +89,7 @@ def additional_info(self, additional_info): def entries(self): """ Gets the entries of this ParserTestResult. - entries + The test result log entries. :return: The entries of this ParserTestResult. @@ -101,7 +101,7 @@ def entries(self): def entries(self, entries): """ Sets the entries of this ParserTestResult. - entries + The test result log entries. :param entries: The entries of this ParserTestResult. @@ -113,7 +113,7 @@ def entries(self, entries): def example_content(self): """ Gets the example_content of this ParserTestResult. - example content + The example content. :return: The example_content of this ParserTestResult. @@ -125,7 +125,7 @@ def example_content(self): def example_content(self, example_content): """ Sets the example_content of this ParserTestResult. - example content + The example content. :param example_content: The example_content of this ParserTestResult. @@ -137,7 +137,7 @@ def example_content(self, example_content): def lines(self): """ Gets the lines of this ParserTestResult. - lines + The test result log lines. :return: The lines of this ParserTestResult. @@ -149,7 +149,7 @@ def lines(self): def lines(self, lines): """ Sets the lines of this ParserTestResult. - lines + The test result log lines. :param lines: The lines of this ParserTestResult. @@ -161,7 +161,7 @@ def lines(self, lines): def named_capture_groups(self): """ Gets the named_capture_groups of this ParserTestResult. - named capture groups + The named capture groups. :return: The named_capture_groups of this ParserTestResult. @@ -173,7 +173,7 @@ def named_capture_groups(self): def named_capture_groups(self, named_capture_groups): """ Sets the named_capture_groups of this ParserTestResult. - named capture groups + The named capture groups. :param named_capture_groups: The named_capture_groups of this ParserTestResult. diff --git a/src/oci/log_analytics/models/regex_match_result.py b/src/oci/log_analytics/models/regex_match_result.py index 6c2a1857d9..7ae42b3a95 100644 --- a/src/oci/log_analytics/models/regex_match_result.py +++ b/src/oci/log_analytics/models/regex_match_result.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def matched_log_entry_end_index(self): """ Gets the matched_log_entry_end_index of this RegexMatchResult. - matchedLogEntryEndIndex + The matched log entry end index. :return: The matched_log_entry_end_index of this RegexMatchResult. @@ -77,7 +77,7 @@ def matched_log_entry_end_index(self): def matched_log_entry_end_index(self, matched_log_entry_end_index): """ Sets the matched_log_entry_end_index of this RegexMatchResult. - matchedLogEntryEndIndex + The matched log entry end index. :param matched_log_entry_end_index: The matched_log_entry_end_index of this RegexMatchResult. @@ -89,7 +89,7 @@ def matched_log_entry_end_index(self, matched_log_entry_end_index): def regex_score(self): """ Gets the regex_score of this RegexMatchResult. - regexScore + The regular expression score. :return: The regex_score of this RegexMatchResult. @@ -101,7 +101,7 @@ def regex_score(self): def regex_score(self, regex_score): """ Sets the regex_score of this RegexMatchResult. - regexScore + The regular expression score. :param regex_score: The regex_score of this RegexMatchResult. @@ -113,7 +113,7 @@ def regex_score(self, regex_score): def regex_steps_info(self): """ Gets the regex_steps_info of this RegexMatchResult. - regexStepsInfo + The regular expression steps information. :return: The regex_steps_info of this RegexMatchResult. @@ -125,7 +125,7 @@ def regex_steps_info(self): def regex_steps_info(self, regex_steps_info): """ Sets the regex_steps_info of this RegexMatchResult. - regexStepsInfo + The regular expression steps information. :param regex_steps_info: The regex_steps_info of this RegexMatchResult. @@ -137,7 +137,7 @@ def regex_steps_info(self, regex_steps_info): def step_count(self): """ Gets the step_count of this RegexMatchResult. - stepCount + The regular expression step count. :return: The step_count of this RegexMatchResult. @@ -149,7 +149,7 @@ def step_count(self): def step_count(self, step_count): """ Sets the step_count of this RegexMatchResult. - stepCount + The regular expression step count. :param step_count: The step_count of this RegexMatchResult. @@ -161,7 +161,7 @@ def step_count(self, step_count): def sub_regexes_match_info(self): """ Gets the sub_regexes_match_info of this RegexMatchResult. - subRegexesMatchInfo + The regular expression match information. :return: The sub_regexes_match_info of this RegexMatchResult. @@ -173,7 +173,7 @@ def sub_regexes_match_info(self): def sub_regexes_match_info(self, sub_regexes_match_info): """ Sets the sub_regexes_match_info of this RegexMatchResult. - subRegexesMatchInfo + The regular expression match information. :param sub_regexes_match_info: The sub_regexes_match_info of this RegexMatchResult. diff --git a/src/oci/log_analytics/models/source_summary_report.py b/src/oci/log_analytics/models/source_summary_report.py index fc32cf974d..3cd9f9baae 100644 --- a/src/oci/log_analytics/models/source_summary_report.py +++ b/src/oci/log_analytics/models/source_summary_report.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def non_oob_count(self): """ Gets the non_oob_count of this SourceSummaryReport. - non out-of-the-box count + The count of custom (user defined) sources. :return: The non_oob_count of this SourceSummaryReport. @@ -63,7 +63,7 @@ def non_oob_count(self): def non_oob_count(self, non_oob_count): """ Sets the non_oob_count of this SourceSummaryReport. - non out-of-the-box count + The count of custom (user defined) sources. :param non_oob_count: The non_oob_count of this SourceSummaryReport. @@ -75,7 +75,7 @@ def non_oob_count(self, non_oob_count): def auto_association_source_count(self): """ Gets the auto_association_source_count of this SourceSummaryReport. - count of sources set to auto-associate + The count of sources set to auto-associate. :return: The auto_association_source_count of this SourceSummaryReport. @@ -87,7 +87,7 @@ def auto_association_source_count(self): def auto_association_source_count(self, auto_association_source_count): """ Sets the auto_association_source_count of this SourceSummaryReport. - count of sources set to auto-associate + The count of sources set to auto-associate. :param auto_association_source_count: The auto_association_source_count of this SourceSummaryReport. @@ -99,7 +99,7 @@ def auto_association_source_count(self, auto_association_source_count): def oob_count(self): """ Gets the oob_count of this SourceSummaryReport. - out-of-the-box count + The count of built in sources. :return: The oob_count of this SourceSummaryReport. @@ -111,7 +111,7 @@ def oob_count(self): def oob_count(self, oob_count): """ Sets the oob_count of this SourceSummaryReport. - out-of-the-box count + The count of built in sources. :param oob_count: The oob_count of this SourceSummaryReport. diff --git a/src/oci/log_analytics/models/source_validate_details.py b/src/oci/log_analytics/models/source_validate_details.py index aecaf0c019..4bc426aa2d 100644 --- a/src/oci/log_analytics/models/source_validate_details.py +++ b/src/oci/log_analytics/models/source_validate_details.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def key(self): """ Gets the key of this SourceValidateDetails. - key + The key. :return: The key of this SourceValidateDetails. @@ -56,7 +56,7 @@ def key(self): def key(self, key): """ Sets the key of this SourceValidateDetails. - key + The key. :param key: The key of this SourceValidateDetails. @@ -68,7 +68,7 @@ def key(self, key): def value(self): """ Gets the value of this SourceValidateDetails. - value + The value. :return: The value of this SourceValidateDetails. @@ -80,7 +80,7 @@ def value(self): def value(self, value): """ Sets the value of this SourceValidateDetails. - value + The value. :param value: The value of this SourceValidateDetails. diff --git a/src/oci/log_analytics/models/source_validate_results.py b/src/oci/log_analytics/models/source_validate_results.py index 9e24ae205b..79cbd004f9 100644 --- a/src/oci/log_analytics/models/source_validate_results.py +++ b/src/oci/log_analytics/models/source_validate_results.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ Gets the items of this SourceValidateResults. - items + An arrya of source validation details. :return: The items of this SourceValidateResults. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this SourceValidateResults. - items + An arrya of source validation details. :param items: The items of this SourceValidateResults. diff --git a/src/oci/log_analytics/models/status_summary.py b/src/oci/log_analytics/models/status_summary.py index 6cddfc3b2f..ebb61b88d4 100644 --- a/src/oci/log_analytics/models/status_summary.py +++ b/src/oci/log_analytics/models/status_summary.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def chunks_processed(self): """ Gets the chunks_processed of this StatusSummary. - chunks processed + The number of chunks processed. :return: The chunks_processed of this StatusSummary. @@ -77,7 +77,7 @@ def chunks_processed(self): def chunks_processed(self, chunks_processed): """ Sets the chunks_processed of this StatusSummary. - chunks processed + The number of chunks processed. :param chunks_processed: The chunks_processed of this StatusSummary. @@ -89,7 +89,7 @@ def chunks_processed(self, chunks_processed): def failure_details(self): """ Gets the failure_details of this StatusSummary. - failure details + The failure details, if any. :return: The failure_details of this StatusSummary. @@ -101,7 +101,7 @@ def failure_details(self): def failure_details(self, failure_details): """ Sets the failure_details of this StatusSummary. - failure details + The failure details, if any. :param failure_details: The failure_details of this StatusSummary. @@ -113,7 +113,7 @@ def failure_details(self, failure_details): def filename(self): """ Gets the filename of this StatusSummary. - filename + The filename. :return: The filename of this StatusSummary. @@ -125,7 +125,7 @@ def filename(self): def filename(self, filename): """ Sets the filename of this StatusSummary. - filename + The filename. :param filename: The filename of this StatusSummary. @@ -137,7 +137,7 @@ def filename(self, filename): def status(self): """ Gets the status of this StatusSummary. - status + The status. :return: The status of this StatusSummary. @@ -149,7 +149,7 @@ def status(self): def status(self, status): """ Sets the status of this StatusSummary. - status + The status. :param status: The status of this StatusSummary. @@ -161,7 +161,7 @@ def status(self, status): def total_chunks(self): """ Gets the total_chunks of this StatusSummary. - total chunks + The total number of chunks. :return: The total_chunks of this StatusSummary. @@ -173,7 +173,7 @@ def total_chunks(self): def total_chunks(self, total_chunks): """ Sets the total_chunks of this StatusSummary. - total chunks + The total number of chunks. :param total_chunks: The total_chunks of this StatusSummary. diff --git a/src/oci/log_analytics/models/step_info.py b/src/oci/log_analytics/models/step_info.py index 8830079355..c7375d6b57 100644 --- a/src/oci/log_analytics/models/step_info.py +++ b/src/oci/log_analytics/models/step_info.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def input_sequence_current_match(self): """ Gets the input_sequence_current_match of this StepInfo. - inputSequenceCurrentMatch + The currnet input sequence match. :return: The input_sequence_current_match of this StepInfo. @@ -63,7 +63,7 @@ def input_sequence_current_match(self): def input_sequence_current_match(self, input_sequence_current_match): """ Sets the input_sequence_current_match of this StepInfo. - inputSequenceCurrentMatch + The currnet input sequence match. :param input_sequence_current_match: The input_sequence_current_match of this StepInfo. @@ -75,7 +75,7 @@ def input_sequence_current_match(self, input_sequence_current_match): def regex_engine_class_name(self): """ Gets the regex_engine_class_name of this StepInfo. - regexEngineClassName + The regular expression engine class name. :return: The regex_engine_class_name of this StepInfo. @@ -87,7 +87,7 @@ def regex_engine_class_name(self): def regex_engine_class_name(self, regex_engine_class_name): """ Sets the regex_engine_class_name of this StepInfo. - regexEngineClassName + The regular expression engine class name. :param regex_engine_class_name: The regex_engine_class_name of this StepInfo. @@ -99,7 +99,7 @@ def regex_engine_class_name(self, regex_engine_class_name): def step_count(self): """ Gets the step_count of this StepInfo. - stepCount + The step count. :return: The step_count of this StepInfo. @@ -111,7 +111,7 @@ def step_count(self): def step_count(self, step_count): """ Sets the step_count of this StepInfo. - stepCount + The step count. :param step_count: The step_count of this StepInfo. diff --git a/src/oci/log_analytics/models/test_parser_payload_details.py b/src/oci/log_analytics/models/test_parser_payload_details.py index 91c0ec7605..340eaaf3f2 100644 --- a/src/oci/log_analytics/models/test_parser_payload_details.py +++ b/src/oci/log_analytics/models/test_parser_payload_details.py @@ -29,6 +29,10 @@ class TestParserPayloadDetails(object): #: This constant has a value of "ODL" TYPE_ODL = "ODL" + #: A constant which can be used with the type property of a TestParserPayloadDetails. + #: This constant has a value of "DELIMITED" + TYPE_DELIMITED = "DELIMITED" + def __init__(self, **kwargs): """ Initializes a new TestParserPayloadDetails object with values from keyword arguments. @@ -126,9 +130,17 @@ def __init__(self, **kwargs): The value to assign to the should_tokenize_original_text property of this TestParserPayloadDetails. :type should_tokenize_original_text: bool + :param field_delimiter: + The value to assign to the field_delimiter property of this TestParserPayloadDetails. + :type field_delimiter: str + + :param field_qualifier: + The value to assign to the field_qualifier property of this TestParserPayloadDetails. + :type field_qualifier: str + :param type: The value to assign to the type property of this TestParserPayloadDetails. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL" + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED" :type type: str """ @@ -156,6 +168,8 @@ def __init__(self, **kwargs): 'is_parser_written_once': 'bool', 'parser_functions': 'list[LogAnalyticsParserFunction]', 'should_tokenize_original_text': 'bool', + 'field_delimiter': 'str', + 'field_qualifier': 'str', 'type': 'str' } @@ -183,6 +197,8 @@ def __init__(self, **kwargs): 'is_parser_written_once': 'isParserWrittenOnce', 'parser_functions': 'parserFunctions', 'should_tokenize_original_text': 'shouldTokenizeOriginalText', + 'field_delimiter': 'fieldDelimiter', + 'field_qualifier': 'fieldQualifier', 'type': 'type' } @@ -209,13 +225,15 @@ def __init__(self, **kwargs): self._is_parser_written_once = None self._parser_functions = None self._should_tokenize_original_text = None + self._field_delimiter = None + self._field_qualifier = None self._type = None @property def content(self): """ Gets the content of this TestParserPayloadDetails. - content + The content used for testing. :return: The content of this TestParserPayloadDetails. @@ -227,7 +245,7 @@ def content(self): def content(self, content): """ Sets the content of this TestParserPayloadDetails. - content + The content used for testing. :param content: The content of this TestParserPayloadDetails. @@ -239,7 +257,7 @@ def content(self, content): def description(self): """ Gets the description of this TestParserPayloadDetails. - description + The parser description. :return: The description of this TestParserPayloadDetails. @@ -251,7 +269,7 @@ def description(self): def description(self, description): """ Sets the description of this TestParserPayloadDetails. - description + The parser description. :param description: The description of this TestParserPayloadDetails. @@ -263,7 +281,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this TestParserPayloadDetails. - Display name + The parser display name. :return: The display_name of this TestParserPayloadDetails. @@ -275,7 +293,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TestParserPayloadDetails. - Display name + The parser display name. :param display_name: The display_name of this TestParserPayloadDetails. @@ -287,7 +305,7 @@ def display_name(self, display_name): def encoding(self): """ Gets the encoding of this TestParserPayloadDetails. - encoding + The content encoding. :return: The encoding of this TestParserPayloadDetails. @@ -299,7 +317,7 @@ def encoding(self): def encoding(self, encoding): """ Sets the encoding of this TestParserPayloadDetails. - encoding + The content encoding. :param encoding: The encoding of this TestParserPayloadDetails. @@ -311,7 +329,7 @@ def encoding(self, encoding): def example_content(self): """ Gets the example_content of this TestParserPayloadDetails. - exampleContent + The example content. :return: The example_content of this TestParserPayloadDetails. @@ -323,7 +341,7 @@ def example_content(self): def example_content(self, example_content): """ Sets the example_content of this TestParserPayloadDetails. - exampleContent + The example content. :param example_content: The example_content of this TestParserPayloadDetails. @@ -335,7 +353,7 @@ def example_content(self, example_content): def field_maps(self): """ Gets the field_maps of this TestParserPayloadDetails. - fieldMaps + The parser fields. :return: The field_maps of this TestParserPayloadDetails. @@ -347,7 +365,7 @@ def field_maps(self): def field_maps(self, field_maps): """ Sets the field_maps of this TestParserPayloadDetails. - fieldMaps + The parser fields. :param field_maps: The field_maps of this TestParserPayloadDetails. @@ -359,7 +377,7 @@ def field_maps(self, field_maps): def footer_content(self): """ Gets the footer_content of this TestParserPayloadDetails. - footerRegex + The footer regular expression. :return: The footer_content of this TestParserPayloadDetails. @@ -371,7 +389,7 @@ def footer_content(self): def footer_content(self, footer_content): """ Sets the footer_content of this TestParserPayloadDetails. - footerRegex + The footer regular expression. :param footer_content: The footer_content of this TestParserPayloadDetails. @@ -383,7 +401,7 @@ def footer_content(self, footer_content): def header_content(self): """ Gets the header_content of this TestParserPayloadDetails. - headerContent + The header content. :return: The header_content of this TestParserPayloadDetails. @@ -395,7 +413,7 @@ def header_content(self): def header_content(self, header_content): """ Sets the header_content of this TestParserPayloadDetails. - headerContent + The header content. :param header_content: The header_content of this TestParserPayloadDetails. @@ -407,7 +425,7 @@ def header_content(self, header_content): def name(self): """ Gets the name of this TestParserPayloadDetails. - name + The parser name. :return: The name of this TestParserPayloadDetails. @@ -419,7 +437,7 @@ def name(self): def name(self, name): """ Sets the name of this TestParserPayloadDetails. - name + The parser name. :param name: The name of this TestParserPayloadDetails. @@ -431,7 +449,7 @@ def name(self, name): def is_default(self): """ Gets the is_default of this TestParserPayloadDetails. - isDefault + A flag indicating if this is a default parser. :return: The is_default of this TestParserPayloadDetails. @@ -443,7 +461,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this TestParserPayloadDetails. - isDefault + A flag indicating if this is a default parser. :param is_default: The is_default of this TestParserPayloadDetails. @@ -455,7 +473,7 @@ def is_default(self, is_default): def is_single_line_content(self): """ Gets the is_single_line_content of this TestParserPayloadDetails. - isSingleLineContent + A flag indicating if this is a single line content parser. :return: The is_single_line_content of this TestParserPayloadDetails. @@ -467,7 +485,7 @@ def is_single_line_content(self): def is_single_line_content(self, is_single_line_content): """ Sets the is_single_line_content of this TestParserPayloadDetails. - isSingleLineContent + A flag indicating if this is a single line content parser. :param is_single_line_content: The is_single_line_content of this TestParserPayloadDetails. @@ -479,7 +497,8 @@ def is_single_line_content(self, is_single_line_content): def is_system(self): """ Gets the is_system of this TestParserPayloadDetails. - isSystem + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this TestParserPayloadDetails. @@ -491,7 +510,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this TestParserPayloadDetails. - isSystem + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this TestParserPayloadDetails. @@ -503,7 +523,7 @@ def is_system(self, is_system): def language(self): """ Gets the language of this TestParserPayloadDetails. - language + The language. :return: The language of this TestParserPayloadDetails. @@ -515,7 +535,7 @@ def language(self): def language(self, language): """ Sets the language of this TestParserPayloadDetails. - language + The language. :param language: The language of this TestParserPayloadDetails. @@ -527,7 +547,7 @@ def language(self, language): def time_updated(self): """ Gets the time_updated of this TestParserPayloadDetails. - lastUpdatedDate + The last updated date. :return: The time_updated of this TestParserPayloadDetails. @@ -539,7 +559,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this TestParserPayloadDetails. - lastUpdatedDate + The last updated date. :param time_updated: The time_updated of this TestParserPayloadDetails. @@ -551,7 +571,7 @@ def time_updated(self, time_updated): def log_type_test_request_version(self): """ Gets the log_type_test_request_version of this TestParserPayloadDetails. - logTypeTestRequestVersion + The log type test request version. :return: The log_type_test_request_version of this TestParserPayloadDetails. @@ -563,7 +583,7 @@ def log_type_test_request_version(self): def log_type_test_request_version(self, log_type_test_request_version): """ Sets the log_type_test_request_version of this TestParserPayloadDetails. - logTypeTestRequestVersion + The log type test request version. :param log_type_test_request_version: The log_type_test_request_version of this TestParserPayloadDetails. @@ -595,7 +615,7 @@ def metadata(self, metadata): def parser_ignoreline_characters(self): """ Gets the parser_ignoreline_characters of this TestParserPayloadDetails. - parser ignore linechars + The line characters for the parser to ignore. :return: The parser_ignoreline_characters of this TestParserPayloadDetails. @@ -607,7 +627,7 @@ def parser_ignoreline_characters(self): def parser_ignoreline_characters(self, parser_ignoreline_characters): """ Sets the parser_ignoreline_characters of this TestParserPayloadDetails. - parser ignore linechars + The line characters for the parser to ignore. :param parser_ignoreline_characters: The parser_ignoreline_characters of this TestParserPayloadDetails. @@ -619,7 +639,7 @@ def parser_ignoreline_characters(self, parser_ignoreline_characters): def is_hidden(self): """ Gets the is_hidden of this TestParserPayloadDetails. - parser is hidden + A flag indicating if the parser is hidden or not. :return: The is_hidden of this TestParserPayloadDetails. @@ -631,7 +651,7 @@ def is_hidden(self): def is_hidden(self, is_hidden): """ Sets the is_hidden of this TestParserPayloadDetails. - parser is hidden + A flag indicating if the parser is hidden or not. :param is_hidden: The is_hidden of this TestParserPayloadDetails. @@ -643,7 +663,7 @@ def is_hidden(self, is_hidden): def parser_sequence(self): """ Gets the parser_sequence of this TestParserPayloadDetails. - parser seq + The parser sequence. :return: The parser_sequence of this TestParserPayloadDetails. @@ -655,7 +675,7 @@ def parser_sequence(self): def parser_sequence(self, parser_sequence): """ Sets the parser_sequence of this TestParserPayloadDetails. - parser seq + The parser sequence. :param parser_sequence: The parser_sequence of this TestParserPayloadDetails. @@ -667,7 +687,7 @@ def parser_sequence(self, parser_sequence): def parser_timezone(self): """ Gets the parser_timezone of this TestParserPayloadDetails. - parser timezone + The parser timezone. :return: The parser_timezone of this TestParserPayloadDetails. @@ -679,7 +699,7 @@ def parser_timezone(self): def parser_timezone(self, parser_timezone): """ Sets the parser_timezone of this TestParserPayloadDetails. - parser timezone + The parser timezone. :param parser_timezone: The parser_timezone of this TestParserPayloadDetails. @@ -691,7 +711,7 @@ def parser_timezone(self, parser_timezone): def is_parser_written_once(self): """ Gets the is_parser_written_once of this TestParserPayloadDetails. - isParserWrittenOnce + A flag indicating whther or not the parser is write once. :return: The is_parser_written_once of this TestParserPayloadDetails. @@ -703,7 +723,7 @@ def is_parser_written_once(self): def is_parser_written_once(self, is_parser_written_once): """ Sets the is_parser_written_once of this TestParserPayloadDetails. - isParserWrittenOnce + A flag indicating whther or not the parser is write once. :param is_parser_written_once: The is_parser_written_once of this TestParserPayloadDetails. @@ -715,7 +735,7 @@ def is_parser_written_once(self, is_parser_written_once): def parser_functions(self): """ Gets the parser_functions of this TestParserPayloadDetails. - plugin instance list + The parser function list. :return: The parser_functions of this TestParserPayloadDetails. @@ -727,7 +747,7 @@ def parser_functions(self): def parser_functions(self, parser_functions): """ Sets the parser_functions of this TestParserPayloadDetails. - plugin instance list + The parser function list. :param parser_functions: The parser_functions of this TestParserPayloadDetails. @@ -739,7 +759,7 @@ def parser_functions(self, parser_functions): def should_tokenize_original_text(self): """ Gets the should_tokenize_original_text of this TestParserPayloadDetails. - tokenize original text + A flag indicating whether or not to tokenize the original text. :return: The should_tokenize_original_text of this TestParserPayloadDetails. @@ -751,7 +771,7 @@ def should_tokenize_original_text(self): def should_tokenize_original_text(self, should_tokenize_original_text): """ Sets the should_tokenize_original_text of this TestParserPayloadDetails. - tokenize original text + A flag indicating whether or not to tokenize the original text. :param should_tokenize_original_text: The should_tokenize_original_text of this TestParserPayloadDetails. @@ -759,13 +779,61 @@ def should_tokenize_original_text(self, should_tokenize_original_text): """ self._should_tokenize_original_text = should_tokenize_original_text + @property + def field_delimiter(self): + """ + Gets the field_delimiter of this TestParserPayloadDetails. + The parser field delimiter. + + + :return: The field_delimiter of this TestParserPayloadDetails. + :rtype: str + """ + return self._field_delimiter + + @field_delimiter.setter + def field_delimiter(self, field_delimiter): + """ + Sets the field_delimiter of this TestParserPayloadDetails. + The parser field delimiter. + + + :param field_delimiter: The field_delimiter of this TestParserPayloadDetails. + :type: str + """ + self._field_delimiter = field_delimiter + + @property + def field_qualifier(self): + """ + Gets the field_qualifier of this TestParserPayloadDetails. + The parser field qualifier. + + + :return: The field_qualifier of this TestParserPayloadDetails. + :rtype: str + """ + return self._field_qualifier + + @field_qualifier.setter + def field_qualifier(self, field_qualifier): + """ + Sets the field_qualifier of this TestParserPayloadDetails. + The parser field qualifier. + + + :param field_qualifier: The field_qualifier of this TestParserPayloadDetails. + :type: str + """ + self._field_qualifier = field_qualifier + @property def type(self): """ Gets the type of this TestParserPayloadDetails. - type + The parser type. Default value is REGEX. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL" + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED" :return: The type of this TestParserPayloadDetails. @@ -777,13 +845,13 @@ def type(self): def type(self, type): """ Sets the type of this TestParserPayloadDetails. - type + The parser type. Default value is REGEX. :param type: The type of this TestParserPayloadDetails. :type: str """ - allowed_values = ["XML", "JSON", "REGEX", "ODL"] + allowed_values = ["XML", "JSON", "REGEX", "ODL", "DELIMITED"] if not value_allowed_none_or_none_sentinel(type, allowed_values): raise ValueError( "Invalid value for `type`, must be None or one of {0}" diff --git a/src/oci/log_analytics/models/ui_parser_test_metadata.py b/src/oci/log_analytics/models/ui_parser_test_metadata.py index b7199f5fc2..a510fca761 100644 --- a/src/oci/log_analytics/models/ui_parser_test_metadata.py +++ b/src/oci/log_analytics/models/ui_parser_test_metadata.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def last_modified_time(self): """ Gets the last_modified_time of this UiParserTestMetadata. - Last modified time + The last modified time. :return: The last_modified_time of this UiParserTestMetadata. @@ -63,7 +63,7 @@ def last_modified_time(self): def last_modified_time(self, last_modified_time): """ Sets the last_modified_time of this UiParserTestMetadata. - Last modified time + The last modified time. :param last_modified_time: The last_modified_time of this UiParserTestMetadata. @@ -75,7 +75,7 @@ def last_modified_time(self, last_modified_time): def log_file_name(self): """ Gets the log_file_name of this UiParserTestMetadata. - Name of log file + The log file name. :return: The log_file_name of this UiParserTestMetadata. @@ -87,7 +87,7 @@ def log_file_name(self): def log_file_name(self, log_file_name): """ Sets the log_file_name of this UiParserTestMetadata. - Name of log file + The log file name. :param log_file_name: The log_file_name of this UiParserTestMetadata. @@ -99,7 +99,7 @@ def log_file_name(self, log_file_name): def time_zone(self): """ Gets the time_zone of this UiParserTestMetadata. - timeZone + The time zone. :return: The time_zone of this UiParserTestMetadata. @@ -111,7 +111,7 @@ def time_zone(self): def time_zone(self, time_zone): """ Sets the time_zone of this UiParserTestMetadata. - timeZone + The time zone. :param time_zone: The time_zone of this UiParserTestMetadata. diff --git a/src/oci/log_analytics/models/update_log_analytics_em_bridge_details.py b/src/oci/log_analytics/models/update_log_analytics_em_bridge_details.py new file mode 100644 index 0000000000..b6a9ab0ba0 --- /dev/null +++ b/src/oci/log_analytics/models/update_log_analytics_em_bridge_details.py @@ -0,0 +1,198 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateLogAnalyticsEmBridgeDetails(object): + """ + Log analytics entity type definition to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateLogAnalyticsEmBridgeDetails 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 UpdateLogAnalyticsEmBridgeDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateLogAnalyticsEmBridgeDetails. + :type description: str + + :param bucket_name: + The value to assign to the bucket_name property of this UpdateLogAnalyticsEmBridgeDetails. + :type bucket_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateLogAnalyticsEmBridgeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateLogAnalyticsEmBridgeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'bucket_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'bucket_name': 'bucketName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._bucket_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateLogAnalyticsEmBridgeDetails. + Log analytics enterprise manager bridge display name. + + + :return: The display_name of this UpdateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateLogAnalyticsEmBridgeDetails. + Log analytics enterprise manager bridge display name. + + + :param display_name: The display_name of this UpdateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateLogAnalyticsEmBridgeDetails. + A description for log analytics enterprise manager bridge. + + + :return: The description of this UpdateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateLogAnalyticsEmBridgeDetails. + A description for log analytics enterprise manager bridge. + + + :param description: The description of this UpdateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._description = description + + @property + def bucket_name(self): + """ + Gets the bucket_name of this UpdateLogAnalyticsEmBridgeDetails. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :return: The bucket_name of this UpdateLogAnalyticsEmBridgeDetails. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this UpdateLogAnalyticsEmBridgeDetails. + Object store bucket name where enterprise manager harvested entities will be uploaded. + + + :param bucket_name: The bucket_name of this UpdateLogAnalyticsEmBridgeDetails. + :type: str + """ + self._bucket_name = bucket_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateLogAnalyticsEmBridgeDetails. + 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 UpdateLogAnalyticsEmBridgeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateLogAnalyticsEmBridgeDetails. + 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 UpdateLogAnalyticsEmBridgeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateLogAnalyticsEmBridgeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateLogAnalyticsEmBridgeDetails. + :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 UpdateLogAnalyticsEmBridgeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateLogAnalyticsEmBridgeDetails. + :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/log_analytics/models/update_log_analytics_object_collection_rule_details.py b/src/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.py index 740e9a5512..2da57522cd 100644 --- a/src/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.py +++ b/src/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.py @@ -246,7 +246,7 @@ def overrides(self): """ Gets the overrides of this UpdateLogAnalyticsObjectCollectionRuleDetails. Use this to override some property values which are defined at bucket level to the scope of object. - Supported propeties for override are, logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". @@ -260,7 +260,7 @@ def overrides(self, overrides): """ Sets the overrides of this UpdateLogAnalyticsObjectCollectionRuleDetails. Use this to override some property values which are defined at bucket level to the scope of object. - Supported propeties for override are, logSourceName, charEncoding. + Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are \"contains\". diff --git a/src/oci/log_analytics/models/upsert_log_analytics_association.py b/src/oci/log_analytics/models/upsert_log_analytics_association.py index 3b3358ecc6..869d1904c0 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_association.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_association.py @@ -86,7 +86,7 @@ def __init__(self, **kwargs): def agent_id(self): """ Gets the agent_id of this UpsertLogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :return: The agent_id of this UpsertLogAnalyticsAssociation. @@ -98,7 +98,7 @@ def agent_id(self): def agent_id(self, agent_id): """ Sets the agent_id of this UpsertLogAnalyticsAssociation. - Lama Idf + The agent unique identifier. :param agent_id: The agent_id of this UpsertLogAnalyticsAssociation. @@ -110,7 +110,7 @@ def agent_id(self, agent_id): def source_name(self): """ Gets the source_name of this UpsertLogAnalyticsAssociation. - source name + The source name. :return: The source_name of this UpsertLogAnalyticsAssociation. @@ -122,7 +122,7 @@ def source_name(self): def source_name(self, source_name): """ Sets the source_name of this UpsertLogAnalyticsAssociation. - source name + The source name. :param source_name: The source_name of this UpsertLogAnalyticsAssociation. @@ -134,7 +134,7 @@ def source_name(self, source_name): def source_type_name(self): """ Gets the source_type_name of this UpsertLogAnalyticsAssociation. - source type internal name + The source type internal name. :return: The source_type_name of this UpsertLogAnalyticsAssociation. @@ -146,7 +146,7 @@ def source_type_name(self): def source_type_name(self, source_type_name): """ Sets the source_type_name of this UpsertLogAnalyticsAssociation. - source type internal name + The source type internal name. :param source_type_name: The source_type_name of this UpsertLogAnalyticsAssociation. @@ -158,7 +158,7 @@ def source_type_name(self, source_type_name): def entity_id(self): """ Gets the entity_id of this UpsertLogAnalyticsAssociation. - entity GUID + The entity unique identifier. :return: The entity_id of this UpsertLogAnalyticsAssociation. @@ -170,7 +170,7 @@ def entity_id(self): def entity_id(self, entity_id): """ Sets the entity_id of this UpsertLogAnalyticsAssociation. - entity GUID + The entity unique identifier. :param entity_id: The entity_id of this UpsertLogAnalyticsAssociation. @@ -182,7 +182,7 @@ def entity_id(self, entity_id): def entity_name(self): """ Gets the entity_name of this UpsertLogAnalyticsAssociation. - entity name + The entity name. :return: The entity_name of this UpsertLogAnalyticsAssociation. @@ -194,7 +194,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this UpsertLogAnalyticsAssociation. - entity name + The entity name. :param entity_name: The entity_name of this UpsertLogAnalyticsAssociation. @@ -206,7 +206,7 @@ def entity_name(self, entity_name): def entity_type_name(self): """ Gets the entity_type_name of this UpsertLogAnalyticsAssociation. - entity type internal name + The entity type internal name. :return: The entity_type_name of this UpsertLogAnalyticsAssociation. @@ -218,7 +218,7 @@ def entity_type_name(self): def entity_type_name(self, entity_type_name): """ Sets the entity_type_name of this UpsertLogAnalyticsAssociation. - entity type internal name + The entity type internal name. :param entity_type_name: The entity_type_name of this UpsertLogAnalyticsAssociation. @@ -230,7 +230,7 @@ def entity_type_name(self, entity_type_name): def host(self): """ Gets the host of this UpsertLogAnalyticsAssociation. - host name + The host name. :return: The host of this UpsertLogAnalyticsAssociation. @@ -242,7 +242,7 @@ def host(self): def host(self, host): """ Sets the host of this UpsertLogAnalyticsAssociation. - host name + The host name. :param host: The host of this UpsertLogAnalyticsAssociation. @@ -254,7 +254,7 @@ def host(self, host): def log_group_id(self): """ Gets the log_group_id of this UpsertLogAnalyticsAssociation. - log group ocid + The log group unique identifier. :return: The log_group_id of this UpsertLogAnalyticsAssociation. @@ -266,7 +266,7 @@ def log_group_id(self): def log_group_id(self, log_group_id): """ Sets the log_group_id of this UpsertLogAnalyticsAssociation. - log group ocid + The log group unique identifier. :param log_group_id: The log_group_id of this UpsertLogAnalyticsAssociation. diff --git a/src/oci/log_analytics/models/upsert_log_analytics_association_details.py b/src/oci/log_analytics/models/upsert_log_analytics_association_details.py index b8b8d82d6b..f0042ac503 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_association_details.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_association_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpsertLogAnalyticsAssociationDetails(object): """ - UpsertLogAnalyticsAssociationDetails + The required information to update or create a list of associations. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ Gets the compartment_id of this UpsertLogAnalyticsAssociationDetails. - compartmentId + The compartment ID :return: The compartment_id of this UpsertLogAnalyticsAssociationDetails. @@ -56,7 +56,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this UpsertLogAnalyticsAssociationDetails. - compartmentId + The compartment ID :param compartment_id: The compartment_id of this UpsertLogAnalyticsAssociationDetails. @@ -68,7 +68,7 @@ def compartment_id(self, compartment_id): def items(self): """ Gets the items of this UpsertLogAnalyticsAssociationDetails. - list of rule entity association details + The information required to create or update an association. :return: The items of this UpsertLogAnalyticsAssociationDetails. @@ -80,7 +80,7 @@ def items(self): def items(self, items): """ Sets the items of this UpsertLogAnalyticsAssociationDetails. - list of rule entity association details + The information required to create or update an association. :param items: The items of this UpsertLogAnalyticsAssociationDetails. diff --git a/src/oci/log_analytics/models/upsert_log_analytics_field_details.py b/src/oci/log_analytics/models/upsert_log_analytics_field_details.py index 716ae4ebe6..54921e83b6 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_field_details.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_field_details.py @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def data_type(self): """ Gets the data_type of this UpsertLogAnalyticsFieldDetails. - data type + The data type. :return: The data_type of this UpsertLogAnalyticsFieldDetails. @@ -77,7 +77,7 @@ def data_type(self): def data_type(self, data_type): """ Sets the data_type of this UpsertLogAnalyticsFieldDetails. - data type + The data type. :param data_type: The data_type of this UpsertLogAnalyticsFieldDetails. @@ -89,7 +89,7 @@ def data_type(self, data_type): def is_multi_valued(self): """ Gets the is_multi_valued of this UpsertLogAnalyticsFieldDetails. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :return: The is_multi_valued of this UpsertLogAnalyticsFieldDetails. @@ -101,7 +101,7 @@ def is_multi_valued(self): def is_multi_valued(self, is_multi_valued): """ Sets the is_multi_valued of this UpsertLogAnalyticsFieldDetails. - is multi-valued flag + A flag indicating whether or not the field is multi-valued. :param is_multi_valued: The is_multi_valued of this UpsertLogAnalyticsFieldDetails. @@ -113,7 +113,7 @@ def is_multi_valued(self, is_multi_valued): def description(self): """ Gets the description of this UpsertLogAnalyticsFieldDetails. - description + The field description. :return: The description of this UpsertLogAnalyticsFieldDetails. @@ -125,7 +125,7 @@ def description(self): def description(self, description): """ Sets the description of this UpsertLogAnalyticsFieldDetails. - description + The field description. :param description: The description of this UpsertLogAnalyticsFieldDetails. @@ -137,7 +137,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpsertLogAnalyticsFieldDetails. - display name + The field display name. :return: The display_name of this UpsertLogAnalyticsFieldDetails. @@ -149,7 +149,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpsertLogAnalyticsFieldDetails. - display name + The field display name. :param display_name: The display_name of this UpsertLogAnalyticsFieldDetails. @@ -161,7 +161,7 @@ def display_name(self, display_name): def name(self): """ Gets the name of this UpsertLogAnalyticsFieldDetails. - internal name + The field internal name. :return: The name of this UpsertLogAnalyticsFieldDetails. @@ -173,7 +173,7 @@ def name(self): def name(self, name): """ Sets the name of this UpsertLogAnalyticsFieldDetails. - internal name + The field internal name. :param name: The name of this UpsertLogAnalyticsFieldDetails. diff --git a/src/oci/log_analytics/models/upsert_log_analytics_label_details.py b/src/oci/log_analytics/models/upsert_log_analytics_label_details.py index f057c6618b..28c9513013 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_label_details.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_label_details.py @@ -133,7 +133,7 @@ def __init__(self, **kwargs): def aliases(self): """ Gets the aliases of this UpsertLogAnalyticsLabelDetails. - alias list + The alias list. :return: The aliases of this UpsertLogAnalyticsLabelDetails. @@ -145,7 +145,7 @@ def aliases(self): def aliases(self, aliases): """ Sets the aliases of this UpsertLogAnalyticsLabelDetails. - alias list + The alias list. :param aliases: The aliases of this UpsertLogAnalyticsLabelDetails. @@ -181,7 +181,7 @@ def suggest_type(self, suggest_type): def description(self): """ Gets the description of this UpsertLogAnalyticsLabelDetails. - description + The label description. :return: The description of this UpsertLogAnalyticsLabelDetails. @@ -193,7 +193,7 @@ def description(self): def description(self, description): """ Sets the description of this UpsertLogAnalyticsLabelDetails. - description + The label description. :param description: The description of this UpsertLogAnalyticsLabelDetails. @@ -205,7 +205,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpsertLogAnalyticsLabelDetails. - display name + The label display name. :return: The display_name of this UpsertLogAnalyticsLabelDetails. @@ -217,7 +217,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpsertLogAnalyticsLabelDetails. - display name + The label display name. :param display_name: The display_name of this UpsertLogAnalyticsLabelDetails. @@ -229,7 +229,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this UpsertLogAnalyticsLabelDetails. - edit version + The edit version. :return: The edit_version of this UpsertLogAnalyticsLabelDetails. @@ -241,7 +241,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this UpsertLogAnalyticsLabelDetails. - edit version + The edit version. :param edit_version: The edit_version of this UpsertLogAnalyticsLabelDetails. @@ -253,7 +253,7 @@ def edit_version(self, edit_version): def impact(self): """ Gets the impact of this UpsertLogAnalyticsLabelDetails. - impact + The label impact. :return: The impact of this UpsertLogAnalyticsLabelDetails. @@ -265,7 +265,7 @@ def impact(self): def impact(self, impact): """ Sets the impact of this UpsertLogAnalyticsLabelDetails. - impact + The label impact. :param impact: The impact of this UpsertLogAnalyticsLabelDetails. @@ -277,7 +277,8 @@ def impact(self, impact): def is_system(self): """ Gets the is_system of this UpsertLogAnalyticsLabelDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :return: The is_system of this UpsertLogAnalyticsLabelDetails. @@ -289,7 +290,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this UpsertLogAnalyticsLabelDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined label. A value of true denotes a built in label. :param is_system: The is_system of this UpsertLogAnalyticsLabelDetails. @@ -301,7 +303,7 @@ def is_system(self, is_system): def name(self): """ Gets the name of this UpsertLogAnalyticsLabelDetails. - label identifier + The label name. :return: The name of this UpsertLogAnalyticsLabelDetails. @@ -313,7 +315,7 @@ def name(self): def name(self, name): """ Sets the name of this UpsertLogAnalyticsLabelDetails. - label identifier + The label name. :param name: The name of this UpsertLogAnalyticsLabelDetails. @@ -325,7 +327,7 @@ def name(self, name): def priority(self): """ Gets the priority of this UpsertLogAnalyticsLabelDetails. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH" @@ -339,7 +341,7 @@ def priority(self): def priority(self, priority): """ Sets the priority of this UpsertLogAnalyticsLabelDetails. - Valid values are (NONE, LOW, HIGH). NONE is default. + The label priority. Valid values are (NONE, LOW, HIGH). NONE is default. :param priority: The priority of this UpsertLogAnalyticsLabelDetails. @@ -357,7 +359,7 @@ def priority(self, priority): def recommendation(self): """ Gets the recommendation of this UpsertLogAnalyticsLabelDetails. - tag recommendation + The label recommendation. :return: The recommendation of this UpsertLogAnalyticsLabelDetails. @@ -369,7 +371,7 @@ def recommendation(self): def recommendation(self, recommendation): """ Sets the recommendation of this UpsertLogAnalyticsLabelDetails. - tag recommendation + The label recommendation. :param recommendation: The recommendation of this UpsertLogAnalyticsLabelDetails. @@ -381,7 +383,7 @@ def recommendation(self, recommendation): def type(self): """ Gets the type of this UpsertLogAnalyticsLabelDetails. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. Allowed values for this property are: "INFO", "PROBLEM" @@ -395,7 +397,7 @@ def type(self): def type(self, type): """ Sets the type of this UpsertLogAnalyticsLabelDetails. - Valid values are (INFO, PROBLEM). INFO is default. + The label type. Valid values are (INFO, PROBLEM). INFO is default. :param type: The type of this UpsertLogAnalyticsLabelDetails. diff --git a/src/oci/log_analytics/models/upsert_log_analytics_parser_details.py b/src/oci/log_analytics/models/upsert_log_analytics_parser_details.py index 67a80b9b5b..15acf1c567 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_parser_details.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_parser_details.py @@ -29,6 +29,10 @@ class UpsertLogAnalyticsParserDetails(object): #: This constant has a value of "ODL" TYPE_ODL = "ODL" + #: A constant which can be used with the type property of a UpsertLogAnalyticsParserDetails. + #: This constant has a value of "DELIMITED" + TYPE_DELIMITED = "DELIMITED" + def __init__(self, **kwargs): """ Initializes a new UpsertLogAnalyticsParserDetails object with values from keyword arguments. @@ -118,9 +122,17 @@ def __init__(self, **kwargs): The value to assign to the should_tokenize_original_text property of this UpsertLogAnalyticsParserDetails. :type should_tokenize_original_text: bool + :param field_delimiter: + The value to assign to the field_delimiter property of this UpsertLogAnalyticsParserDetails. + :type field_delimiter: str + + :param field_qualifier: + The value to assign to the field_qualifier property of this UpsertLogAnalyticsParserDetails. + :type field_qualifier: str + :param type: The value to assign to the type property of this UpsertLogAnalyticsParserDetails. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL" + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED" :type type: str """ @@ -146,6 +158,8 @@ def __init__(self, **kwargs): 'is_parser_written_once': 'bool', 'parser_functions': 'list[LogAnalyticsParserFunction]', 'should_tokenize_original_text': 'bool', + 'field_delimiter': 'str', + 'field_qualifier': 'str', 'type': 'str' } @@ -171,6 +185,8 @@ def __init__(self, **kwargs): 'is_parser_written_once': 'isParserWrittenOnce', 'parser_functions': 'parserFunctions', 'should_tokenize_original_text': 'shouldTokenizeOriginalText', + 'field_delimiter': 'fieldDelimiter', + 'field_qualifier': 'fieldQualifier', 'type': 'type' } @@ -195,13 +211,15 @@ def __init__(self, **kwargs): self._is_parser_written_once = None self._parser_functions = None self._should_tokenize_original_text = None + self._field_delimiter = None + self._field_qualifier = None self._type = None @property def content(self): """ Gets the content of this UpsertLogAnalyticsParserDetails. - content + The content. :return: The content of this UpsertLogAnalyticsParserDetails. @@ -213,7 +231,7 @@ def content(self): def content(self, content): """ Sets the content of this UpsertLogAnalyticsParserDetails. - content + The content. :param content: The content of this UpsertLogAnalyticsParserDetails. @@ -225,7 +243,7 @@ def content(self, content): def description(self): """ Gets the description of this UpsertLogAnalyticsParserDetails. - description + The parser description. :return: The description of this UpsertLogAnalyticsParserDetails. @@ -237,7 +255,7 @@ def description(self): def description(self, description): """ Sets the description of this UpsertLogAnalyticsParserDetails. - description + The parser description. :param description: The description of this UpsertLogAnalyticsParserDetails. @@ -249,7 +267,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpsertLogAnalyticsParserDetails. - display name + The parser display name. :return: The display_name of this UpsertLogAnalyticsParserDetails. @@ -261,7 +279,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpsertLogAnalyticsParserDetails. - display name + The parser display name. :param display_name: The display_name of this UpsertLogAnalyticsParserDetails. @@ -273,7 +291,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this UpsertLogAnalyticsParserDetails. - edit version + The parser edit version. :return: The edit_version of this UpsertLogAnalyticsParserDetails. @@ -285,7 +303,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this UpsertLogAnalyticsParserDetails. - edit version + The parser edit version. :param edit_version: The edit_version of this UpsertLogAnalyticsParserDetails. @@ -297,7 +315,7 @@ def edit_version(self, edit_version): def encoding(self): """ Gets the encoding of this UpsertLogAnalyticsParserDetails. - encoding + The encoding. :return: The encoding of this UpsertLogAnalyticsParserDetails. @@ -309,7 +327,7 @@ def encoding(self): def encoding(self, encoding): """ Sets the encoding of this UpsertLogAnalyticsParserDetails. - encoding + The encoding. :param encoding: The encoding of this UpsertLogAnalyticsParserDetails. @@ -321,7 +339,7 @@ def encoding(self, encoding): def example_content(self): """ Gets the example_content of this UpsertLogAnalyticsParserDetails. - example content + Example content. :return: The example_content of this UpsertLogAnalyticsParserDetails. @@ -333,7 +351,7 @@ def example_content(self): def example_content(self, example_content): """ Sets the example_content of this UpsertLogAnalyticsParserDetails. - example content + Example content. :param example_content: The example_content of this UpsertLogAnalyticsParserDetails. @@ -345,7 +363,7 @@ def example_content(self, example_content): def field_maps(self): """ Gets the field_maps of this UpsertLogAnalyticsParserDetails. - fields Maps + The parser fields. :return: The field_maps of this UpsertLogAnalyticsParserDetails. @@ -357,7 +375,7 @@ def field_maps(self): def field_maps(self, field_maps): """ Sets the field_maps of this UpsertLogAnalyticsParserDetails. - fields Maps + The parser fields. :param field_maps: The field_maps of this UpsertLogAnalyticsParserDetails. @@ -369,7 +387,7 @@ def field_maps(self, field_maps): def footer_content(self): """ Gets the footer_content of this UpsertLogAnalyticsParserDetails. - footer regular expression + The footer regular expression. :return: The footer_content of this UpsertLogAnalyticsParserDetails. @@ -381,7 +399,7 @@ def footer_content(self): def footer_content(self, footer_content): """ Sets the footer_content of this UpsertLogAnalyticsParserDetails. - footer regular expression + The footer regular expression. :param footer_content: The footer_content of this UpsertLogAnalyticsParserDetails. @@ -393,7 +411,7 @@ def footer_content(self, footer_content): def header_content(self): """ Gets the header_content of this UpsertLogAnalyticsParserDetails. - header content + The header content. :return: The header_content of this UpsertLogAnalyticsParserDetails. @@ -405,7 +423,7 @@ def header_content(self): def header_content(self, header_content): """ Sets the header_content of this UpsertLogAnalyticsParserDetails. - header content + The header content. :param header_content: The header_content of this UpsertLogAnalyticsParserDetails. @@ -417,7 +435,7 @@ def header_content(self, header_content): def name(self): """ Gets the name of this UpsertLogAnalyticsParserDetails. - Name + The parser internal name. :return: The name of this UpsertLogAnalyticsParserDetails. @@ -429,7 +447,7 @@ def name(self): def name(self, name): """ Sets the name of this UpsertLogAnalyticsParserDetails. - Name + The parser internal name. :param name: The name of this UpsertLogAnalyticsParserDetails. @@ -441,7 +459,7 @@ def name(self, name): def is_default(self): """ Gets the is_default of this UpsertLogAnalyticsParserDetails. - is default flag + A flag indicating if this is a default parser. :return: The is_default of this UpsertLogAnalyticsParserDetails. @@ -453,7 +471,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this UpsertLogAnalyticsParserDetails. - is default flag + A flag indicating if this is a default parser. :param is_default: The is_default of this UpsertLogAnalyticsParserDetails. @@ -465,7 +483,7 @@ def is_default(self, is_default): def is_single_line_content(self): """ Gets the is_single_line_content of this UpsertLogAnalyticsParserDetails. - is single line content + A flag indicating if this is a single line content parser. :return: The is_single_line_content of this UpsertLogAnalyticsParserDetails. @@ -477,7 +495,7 @@ def is_single_line_content(self): def is_single_line_content(self, is_single_line_content): """ Sets the is_single_line_content of this UpsertLogAnalyticsParserDetails. - is single line content + A flag indicating if this is a single line content parser. :param is_single_line_content: The is_single_line_content of this UpsertLogAnalyticsParserDetails. @@ -489,7 +507,8 @@ def is_single_line_content(self, is_single_line_content): def is_system(self): """ Gets the is_system of this UpsertLogAnalyticsParserDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this UpsertLogAnalyticsParserDetails. @@ -501,7 +520,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this UpsertLogAnalyticsParserDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this UpsertLogAnalyticsParserDetails. @@ -513,7 +533,7 @@ def is_system(self, is_system): def language(self): """ Gets the language of this UpsertLogAnalyticsParserDetails. - language + The language. :return: The language of this UpsertLogAnalyticsParserDetails. @@ -525,7 +545,7 @@ def language(self): def language(self, language): """ Sets the language of this UpsertLogAnalyticsParserDetails. - language + The language. :param language: The language of this UpsertLogAnalyticsParserDetails. @@ -537,7 +557,7 @@ def language(self, language): def log_type_test_request_version(self): """ Gets the log_type_test_request_version of this UpsertLogAnalyticsParserDetails. - log type test request version + The log type test request version. :return: The log_type_test_request_version of this UpsertLogAnalyticsParserDetails. @@ -549,7 +569,7 @@ def log_type_test_request_version(self): def log_type_test_request_version(self, log_type_test_request_version): """ Sets the log_type_test_request_version of this UpsertLogAnalyticsParserDetails. - log type test request version + The log type test request version. :param log_type_test_request_version: The log_type_test_request_version of this UpsertLogAnalyticsParserDetails. @@ -561,7 +581,7 @@ def log_type_test_request_version(self, log_type_test_request_version): def parser_ignoreline_characters(self): """ Gets the parser_ignoreline_characters of this UpsertLogAnalyticsParserDetails. - parser ignore line characters + The line characters for the parser to ignore. :return: The parser_ignoreline_characters of this UpsertLogAnalyticsParserDetails. @@ -573,7 +593,7 @@ def parser_ignoreline_characters(self): def parser_ignoreline_characters(self, parser_ignoreline_characters): """ Sets the parser_ignoreline_characters of this UpsertLogAnalyticsParserDetails. - parser ignore line characters + The line characters for the parser to ignore. :param parser_ignoreline_characters: The parser_ignoreline_characters of this UpsertLogAnalyticsParserDetails. @@ -585,7 +605,7 @@ def parser_ignoreline_characters(self, parser_ignoreline_characters): def parser_sequence(self): """ Gets the parser_sequence of this UpsertLogAnalyticsParserDetails. - sequence + The parser sequence. :return: The parser_sequence of this UpsertLogAnalyticsParserDetails. @@ -597,7 +617,7 @@ def parser_sequence(self): def parser_sequence(self, parser_sequence): """ Sets the parser_sequence of this UpsertLogAnalyticsParserDetails. - sequence + The parser sequence. :param parser_sequence: The parser_sequence of this UpsertLogAnalyticsParserDetails. @@ -609,7 +629,7 @@ def parser_sequence(self, parser_sequence): def parser_timezone(self): """ Gets the parser_timezone of this UpsertLogAnalyticsParserDetails. - time zone + The time zone. :return: The parser_timezone of this UpsertLogAnalyticsParserDetails. @@ -621,7 +641,7 @@ def parser_timezone(self): def parser_timezone(self, parser_timezone): """ Sets the parser_timezone of this UpsertLogAnalyticsParserDetails. - time zone + The time zone. :param parser_timezone: The parser_timezone of this UpsertLogAnalyticsParserDetails. @@ -633,7 +653,7 @@ def parser_timezone(self, parser_timezone): def is_parser_written_once(self): """ Gets the is_parser_written_once of this UpsertLogAnalyticsParserDetails. - write once + A flag indicating whther or not the parser is write once. :return: The is_parser_written_once of this UpsertLogAnalyticsParserDetails. @@ -645,7 +665,7 @@ def is_parser_written_once(self): def is_parser_written_once(self, is_parser_written_once): """ Sets the is_parser_written_once of this UpsertLogAnalyticsParserDetails. - write once + A flag indicating whther or not the parser is write once. :param is_parser_written_once: The is_parser_written_once of this UpsertLogAnalyticsParserDetails. @@ -657,7 +677,7 @@ def is_parser_written_once(self, is_parser_written_once): def parser_functions(self): """ Gets the parser_functions of this UpsertLogAnalyticsParserDetails. - plugin instance list + The parser function list. :return: The parser_functions of this UpsertLogAnalyticsParserDetails. @@ -669,7 +689,7 @@ def parser_functions(self): def parser_functions(self, parser_functions): """ Sets the parser_functions of this UpsertLogAnalyticsParserDetails. - plugin instance list + The parser function list. :param parser_functions: The parser_functions of this UpsertLogAnalyticsParserDetails. @@ -681,7 +701,7 @@ def parser_functions(self, parser_functions): def should_tokenize_original_text(self): """ Gets the should_tokenize_original_text of this UpsertLogAnalyticsParserDetails. - tokenize original text + A flag indicating whether or not to tokenize the original text. :return: The should_tokenize_original_text of this UpsertLogAnalyticsParserDetails. @@ -693,7 +713,7 @@ def should_tokenize_original_text(self): def should_tokenize_original_text(self, should_tokenize_original_text): """ Sets the should_tokenize_original_text of this UpsertLogAnalyticsParserDetails. - tokenize original text + A flag indicating whether or not to tokenize the original text. :param should_tokenize_original_text: The should_tokenize_original_text of this UpsertLogAnalyticsParserDetails. @@ -701,13 +721,61 @@ def should_tokenize_original_text(self, should_tokenize_original_text): """ self._should_tokenize_original_text = should_tokenize_original_text + @property + def field_delimiter(self): + """ + Gets the field_delimiter of this UpsertLogAnalyticsParserDetails. + The parser field delimiter. + + + :return: The field_delimiter of this UpsertLogAnalyticsParserDetails. + :rtype: str + """ + return self._field_delimiter + + @field_delimiter.setter + def field_delimiter(self, field_delimiter): + """ + Sets the field_delimiter of this UpsertLogAnalyticsParserDetails. + The parser field delimiter. + + + :param field_delimiter: The field_delimiter of this UpsertLogAnalyticsParserDetails. + :type: str + """ + self._field_delimiter = field_delimiter + + @property + def field_qualifier(self): + """ + Gets the field_qualifier of this UpsertLogAnalyticsParserDetails. + The parser field qualifier. + + + :return: The field_qualifier of this UpsertLogAnalyticsParserDetails. + :rtype: str + """ + return self._field_qualifier + + @field_qualifier.setter + def field_qualifier(self, field_qualifier): + """ + Sets the field_qualifier of this UpsertLogAnalyticsParserDetails. + The parser field qualifier. + + + :param field_qualifier: The field_qualifier of this UpsertLogAnalyticsParserDetails. + :type: str + """ + self._field_qualifier = field_qualifier + @property def type(self): """ Gets the type of this UpsertLogAnalyticsParserDetails. - type + The parser type. Default value is REGEX. - Allowed values for this property are: "XML", "JSON", "REGEX", "ODL" + Allowed values for this property are: "XML", "JSON", "REGEX", "ODL", "DELIMITED" :return: The type of this UpsertLogAnalyticsParserDetails. @@ -719,13 +787,13 @@ def type(self): def type(self, type): """ Sets the type of this UpsertLogAnalyticsParserDetails. - type + The parser type. Default value is REGEX. :param type: The type of this UpsertLogAnalyticsParserDetails. :type: str """ - allowed_values = ["XML", "JSON", "REGEX", "ODL"] + allowed_values = ["XML", "JSON", "REGEX", "ODL", "DELIMITED"] if not value_allowed_none_or_none_sentinel(type, allowed_values): raise ValueError( "Invalid value for `type`, must be None or one of {0}" diff --git a/src/oci/log_analytics/models/upsert_log_analytics_source_details.py b/src/oci/log_analytics/models/upsert_log_analytics_source_details.py index 21129ede87..14debcb83c 100644 --- a/src/oci/log_analytics/models/upsert_log_analytics_source_details.py +++ b/src/oci/log_analytics/models/upsert_log_analytics_source_details.py @@ -226,7 +226,7 @@ def __init__(self, **kwargs): def label_conditions(self): """ Gets the label_conditions of this UpsertLogAnalyticsSourceDetails. - source label conditions + An array of source label conditions. :return: The label_conditions of this UpsertLogAnalyticsSourceDetails. @@ -238,7 +238,7 @@ def label_conditions(self): def label_conditions(self, label_conditions): """ Sets the label_conditions of this UpsertLogAnalyticsSourceDetails. - source label conditions + An array of source label conditions. :param label_conditions: The label_conditions of this UpsertLogAnalyticsSourceDetails. @@ -250,7 +250,7 @@ def label_conditions(self, label_conditions): def data_filter_definitions(self): """ Gets the data_filter_definitions of this UpsertLogAnalyticsSourceDetails. - data filter definitions + An array of data filter definitions. :return: The data_filter_definitions of this UpsertLogAnalyticsSourceDetails. @@ -262,7 +262,7 @@ def data_filter_definitions(self): def data_filter_definitions(self, data_filter_definitions): """ Sets the data_filter_definitions of this UpsertLogAnalyticsSourceDetails. - data filter definitions + An array of data filter definitions. :param data_filter_definitions: The data_filter_definitions of this UpsertLogAnalyticsSourceDetails. @@ -274,7 +274,7 @@ def data_filter_definitions(self, data_filter_definitions): def database_credential(self): """ Gets the database_credential of this UpsertLogAnalyticsSourceDetails. - DB credential name + The database credential name. :return: The database_credential of this UpsertLogAnalyticsSourceDetails. @@ -286,7 +286,7 @@ def database_credential(self): def database_credential(self, database_credential): """ Sets the database_credential of this UpsertLogAnalyticsSourceDetails. - DB credential name + The database credential name. :param database_credential: The database_credential of this UpsertLogAnalyticsSourceDetails. @@ -298,7 +298,7 @@ def database_credential(self, database_credential): def extended_field_definitions(self): """ Gets the extended_field_definitions of this UpsertLogAnalyticsSourceDetails. - extended field definition + An array of extended field definitions. :return: The extended_field_definitions of this UpsertLogAnalyticsSourceDetails. @@ -310,7 +310,7 @@ def extended_field_definitions(self): def extended_field_definitions(self, extended_field_definitions): """ Sets the extended_field_definitions of this UpsertLogAnalyticsSourceDetails. - extended field definition + An array of extended field definitions. :param extended_field_definitions: The extended_field_definitions of this UpsertLogAnalyticsSourceDetails. @@ -322,7 +322,7 @@ def extended_field_definitions(self, extended_field_definitions): def is_for_cloud(self): """ Gets the is_for_cloud of this UpsertLogAnalyticsSourceDetails. - is for cloud flag + A flag indicating whether or not this is a cloud source. :return: The is_for_cloud of this UpsertLogAnalyticsSourceDetails. @@ -334,7 +334,7 @@ def is_for_cloud(self): def is_for_cloud(self, is_for_cloud): """ Sets the is_for_cloud of this UpsertLogAnalyticsSourceDetails. - is for cloud flag + A flag indicating whether or not this is a cloud source. :param is_for_cloud: The is_for_cloud of this UpsertLogAnalyticsSourceDetails. @@ -346,7 +346,7 @@ def is_for_cloud(self, is_for_cloud): def labels(self): """ Gets the labels of this UpsertLogAnalyticsSourceDetails. - labels + An array of labels. :return: The labels of this UpsertLogAnalyticsSourceDetails. @@ -358,7 +358,7 @@ def labels(self): def labels(self, labels): """ Sets the labels of this UpsertLogAnalyticsSourceDetails. - labels + An array of labels. :param labels: The labels of this UpsertLogAnalyticsSourceDetails. @@ -370,7 +370,7 @@ def labels(self, labels): def metric_definitions(self): """ Gets the metric_definitions of this UpsertLogAnalyticsSourceDetails. - metric definitions + An array of metric definitions. :return: The metric_definitions of this UpsertLogAnalyticsSourceDetails. @@ -382,7 +382,7 @@ def metric_definitions(self): def metric_definitions(self, metric_definitions): """ Sets the metric_definitions of this UpsertLogAnalyticsSourceDetails. - metric definitions + An array of metric definitions. :param metric_definitions: The metric_definitions of this UpsertLogAnalyticsSourceDetails. @@ -394,7 +394,7 @@ def metric_definitions(self, metric_definitions): def metrics(self): """ Gets the metrics of this UpsertLogAnalyticsSourceDetails. - metric source map + An array of metrics. :return: The metrics of this UpsertLogAnalyticsSourceDetails. @@ -406,7 +406,7 @@ def metrics(self): def metrics(self, metrics): """ Sets the metrics of this UpsertLogAnalyticsSourceDetails. - metric source map + An array of metrics. :param metrics: The metrics of this UpsertLogAnalyticsSourceDetails. @@ -418,7 +418,7 @@ def metrics(self, metrics): def oob_parsers(self): """ Gets the oob_parsers of this UpsertLogAnalyticsSourceDetails. - out-of-the-box source parser list + An array of built in source parsers. :return: The oob_parsers of this UpsertLogAnalyticsSourceDetails. @@ -430,7 +430,7 @@ def oob_parsers(self): def oob_parsers(self, oob_parsers): """ Sets the oob_parsers of this UpsertLogAnalyticsSourceDetails. - out-of-the-box source parser list + An array of built in source parsers. :param oob_parsers: The oob_parsers of this UpsertLogAnalyticsSourceDetails. @@ -442,7 +442,7 @@ def oob_parsers(self, oob_parsers): def parameters(self): """ Gets the parameters of this UpsertLogAnalyticsSourceDetails. - parameters + An array of parameters. :return: The parameters of this UpsertLogAnalyticsSourceDetails. @@ -454,7 +454,7 @@ def parameters(self): def parameters(self, parameters): """ Sets the parameters of this UpsertLogAnalyticsSourceDetails. - parameters + An array of parameters. :param parameters: The parameters of this UpsertLogAnalyticsSourceDetails. @@ -466,7 +466,7 @@ def parameters(self, parameters): def patterns(self): """ Gets the patterns of this UpsertLogAnalyticsSourceDetails. - patterns + An array of patterns. :return: The patterns of this UpsertLogAnalyticsSourceDetails. @@ -478,7 +478,7 @@ def patterns(self): def patterns(self, patterns): """ Sets the patterns of this UpsertLogAnalyticsSourceDetails. - patterns + An array of patterns. :param patterns: The patterns of this UpsertLogAnalyticsSourceDetails. @@ -490,7 +490,7 @@ def patterns(self, patterns): def description(self): """ Gets the description of this UpsertLogAnalyticsSourceDetails. - description + The source description. :return: The description of this UpsertLogAnalyticsSourceDetails. @@ -502,7 +502,7 @@ def description(self): def description(self, description): """ Sets the description of this UpsertLogAnalyticsSourceDetails. - description + The source description. :param description: The description of this UpsertLogAnalyticsSourceDetails. @@ -514,7 +514,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpsertLogAnalyticsSourceDetails. - display name + The source display name. :return: The display_name of this UpsertLogAnalyticsSourceDetails. @@ -526,7 +526,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpsertLogAnalyticsSourceDetails. - display name + The source display name. :param display_name: The display_name of this UpsertLogAnalyticsSourceDetails. @@ -538,7 +538,7 @@ def display_name(self, display_name): def edit_version(self): """ Gets the edit_version of this UpsertLogAnalyticsSourceDetails. - source edit version + The source edit version. :return: The edit_version of this UpsertLogAnalyticsSourceDetails. @@ -550,7 +550,7 @@ def edit_version(self): def edit_version(self, edit_version): """ Sets the edit_version of this UpsertLogAnalyticsSourceDetails. - source edit version + The source edit version. :param edit_version: The edit_version of this UpsertLogAnalyticsSourceDetails. @@ -562,7 +562,7 @@ def edit_version(self, edit_version): def functions(self): """ Gets the functions of this UpsertLogAnalyticsSourceDetails. - source functions + An array of source functions. :return: The functions of this UpsertLogAnalyticsSourceDetails. @@ -574,7 +574,7 @@ def functions(self): def functions(self, functions): """ Sets the functions of this UpsertLogAnalyticsSourceDetails. - source functions + An array of source functions. :param functions: The functions of this UpsertLogAnalyticsSourceDetails. @@ -586,7 +586,7 @@ def functions(self, functions): def source_id(self): """ Gets the source_id of this UpsertLogAnalyticsSourceDetails. - source Id + The source unique identifier. :return: The source_id of this UpsertLogAnalyticsSourceDetails. @@ -598,7 +598,7 @@ def source_id(self): def source_id(self, source_id): """ Sets the source_id of this UpsertLogAnalyticsSourceDetails. - source Id + The source unique identifier. :param source_id: The source_id of this UpsertLogAnalyticsSourceDetails. @@ -610,7 +610,7 @@ def source_id(self, source_id): def name(self): """ Gets the name of this UpsertLogAnalyticsSourceDetails. - source internal name + The source internal name. :return: The name of this UpsertLogAnalyticsSourceDetails. @@ -622,7 +622,7 @@ def name(self): def name(self, name): """ Sets the name of this UpsertLogAnalyticsSourceDetails. - source internal name + The source internal name. :param name: The name of this UpsertLogAnalyticsSourceDetails. @@ -634,7 +634,7 @@ def name(self, name): def is_secure_content(self): """ Gets the is_secure_content of this UpsertLogAnalyticsSourceDetails. - is secure content flag + A flag indicating whether or not the source content is secure. :return: The is_secure_content of this UpsertLogAnalyticsSourceDetails. @@ -646,7 +646,7 @@ def is_secure_content(self): def is_secure_content(self, is_secure_content): """ Sets the is_secure_content of this UpsertLogAnalyticsSourceDetails. - is secure content flag + A flag indicating whether or not the source content is secure. :param is_secure_content: The is_secure_content of this UpsertLogAnalyticsSourceDetails. @@ -658,7 +658,8 @@ def is_secure_content(self, is_secure_content): def is_system(self): """ Gets the is_system of this UpsertLogAnalyticsSourceDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :return: The is_system of this UpsertLogAnalyticsSourceDetails. @@ -670,7 +671,8 @@ def is_system(self): def is_system(self, is_system): """ Sets the is_system of this UpsertLogAnalyticsSourceDetails. - is system flag + The system flag. A value of false denotes a custom, or user + defined object. A value of true denotes a built in object. :param is_system: The is_system of this UpsertLogAnalyticsSourceDetails. @@ -682,7 +684,7 @@ def is_system(self, is_system): def parsers(self): """ Gets the parsers of this UpsertLogAnalyticsSourceDetails. - parser list + An array of parser. :return: The parsers of this UpsertLogAnalyticsSourceDetails. @@ -694,7 +696,7 @@ def parsers(self): def parsers(self, parsers): """ Sets the parsers of this UpsertLogAnalyticsSourceDetails. - parser list + An array of parser. :param parsers: The parsers of this UpsertLogAnalyticsSourceDetails. @@ -706,7 +708,7 @@ def parsers(self, parsers): def rule_id(self): """ Gets the rule_id of this UpsertLogAnalyticsSourceDetails. - rule Id + The rule unique identifier. :return: The rule_id of this UpsertLogAnalyticsSourceDetails. @@ -718,7 +720,7 @@ def rule_id(self): def rule_id(self, rule_id): """ Sets the rule_id of this UpsertLogAnalyticsSourceDetails. - rule Id + The rule unique identifier. :param rule_id: The rule_id of this UpsertLogAnalyticsSourceDetails. @@ -730,7 +732,7 @@ def rule_id(self, rule_id): def type_name(self): """ Gets the type_name of this UpsertLogAnalyticsSourceDetails. - source type internal name + The source type internal name. :return: The type_name of this UpsertLogAnalyticsSourceDetails. @@ -742,7 +744,7 @@ def type_name(self): def type_name(self, type_name): """ Sets the type_name of this UpsertLogAnalyticsSourceDetails. - source type internal name + The source type internal name. :param type_name: The type_name of this UpsertLogAnalyticsSourceDetails. @@ -754,7 +756,7 @@ def type_name(self, type_name): def warning_config(self): """ Gets the warning_config of this UpsertLogAnalyticsSourceDetails. - source warning configuration + The source warning configuration. :return: The warning_config of this UpsertLogAnalyticsSourceDetails. @@ -766,7 +768,7 @@ def warning_config(self): def warning_config(self, warning_config): """ Sets the warning_config of this UpsertLogAnalyticsSourceDetails. - source warning configuration + The source warning configuration. :param warning_config: The warning_config of this UpsertLogAnalyticsSourceDetails. @@ -778,7 +780,7 @@ def warning_config(self, warning_config): def metadata_fields(self): """ Gets the metadata_fields of this UpsertLogAnalyticsSourceDetails. - source metadata fields + An array of source metadata fields. :return: The metadata_fields of this UpsertLogAnalyticsSourceDetails. @@ -790,7 +792,7 @@ def metadata_fields(self): def metadata_fields(self, metadata_fields): """ Sets the metadata_fields of this UpsertLogAnalyticsSourceDetails. - source metadata fields + An array of source metadata fields. :param metadata_fields: The metadata_fields of this UpsertLogAnalyticsSourceDetails. @@ -802,7 +804,7 @@ def metadata_fields(self, metadata_fields): def label_definitions(self): """ Gets the label_definitions of this UpsertLogAnalyticsSourceDetails. - tags + An array of labels. :return: The label_definitions of this UpsertLogAnalyticsSourceDetails. @@ -814,7 +816,7 @@ def label_definitions(self): def label_definitions(self, label_definitions): """ Sets the label_definitions of this UpsertLogAnalyticsSourceDetails. - tags + An array of labels. :param label_definitions: The label_definitions of this UpsertLogAnalyticsSourceDetails. @@ -826,7 +828,7 @@ def label_definitions(self, label_definitions): def entity_types(self): """ Gets the entity_types of this UpsertLogAnalyticsSourceDetails. - entity types + An array of entity types. :return: The entity_types of this UpsertLogAnalyticsSourceDetails. @@ -838,7 +840,7 @@ def entity_types(self): def entity_types(self, entity_types): """ Sets the entity_types of this UpsertLogAnalyticsSourceDetails. - entity types + An array of entity types. :param entity_types: The entity_types of this UpsertLogAnalyticsSourceDetails. @@ -850,7 +852,7 @@ def entity_types(self, entity_types): def is_timezone_override(self): """ Gets the is_timezone_override of this UpsertLogAnalyticsSourceDetails. - time zone override + A flag indicating whether or not the source has a time zone override. :return: The is_timezone_override of this UpsertLogAnalyticsSourceDetails. @@ -862,7 +864,7 @@ def is_timezone_override(self): def is_timezone_override(self, is_timezone_override): """ Sets the is_timezone_override of this UpsertLogAnalyticsSourceDetails. - time zone override + A flag indicating whether or not the source has a time zone override. :param is_timezone_override: The is_timezone_override of this UpsertLogAnalyticsSourceDetails. @@ -874,7 +876,7 @@ def is_timezone_override(self, is_timezone_override): def user_parsers(self): """ Gets the user_parsers of this UpsertLogAnalyticsSourceDetails. - source parser list + An array of custom parsers. :return: The user_parsers of this UpsertLogAnalyticsSourceDetails. @@ -886,7 +888,7 @@ def user_parsers(self): def user_parsers(self, user_parsers): """ Sets the user_parsers of this UpsertLogAnalyticsSourceDetails. - source parser list + An array of custom parsers. :param user_parsers: The user_parsers of this UpsertLogAnalyticsSourceDetails. diff --git a/src/oci/log_analytics/models/usage_status_item.py b/src/oci/log_analytics/models/usage_status_item.py index 02cc4f79f3..14dc7d3ed6 100644 --- a/src/oci/log_analytics/models/usage_status_item.py +++ b/src/oci/log_analytics/models/usage_status_item.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def data_type(self): """ Gets the data_type of this UsageStatusItem. - data type + The field data type. :return: The data_type of this UsageStatusItem. @@ -70,7 +70,7 @@ def data_type(self): def data_type(self, data_type): """ Sets the data_type of this UsageStatusItem. - data type + The field data type. :param data_type: The data_type of this UsageStatusItem. @@ -82,7 +82,7 @@ def data_type(self, data_type): def is_multi_valued(self): """ Gets the is_multi_valued of this UsageStatusItem. - is the field multi valued + A flag indicating whether or not the field is multi-valued. :return: The is_multi_valued of this UsageStatusItem. @@ -94,7 +94,7 @@ def is_multi_valued(self): def is_multi_valued(self, is_multi_valued): """ Sets the is_multi_valued of this UsageStatusItem. - is the field multi valued + A flag indicating whether or not the field is multi-valued. :param is_multi_valued: The is_multi_valued of this UsageStatusItem. @@ -106,7 +106,7 @@ def is_multi_valued(self, is_multi_valued): def current_usage(self): """ Gets the current_usage of this UsageStatusItem. - current usage + The current usage of the field. :return: The current_usage of this UsageStatusItem. @@ -118,7 +118,7 @@ def current_usage(self): def current_usage(self, current_usage): """ Sets the current_usage of this UsageStatusItem. - current usage + The current usage of the field. :param current_usage: The current_usage of this UsageStatusItem. @@ -130,7 +130,7 @@ def current_usage(self, current_usage): def max_available(self): """ Gets the max_available of this UsageStatusItem. - maximum available + The maximum availability of the field. :return: The max_available of this UsageStatusItem. @@ -142,7 +142,7 @@ def max_available(self): def max_available(self, max_available): """ Sets the max_available of this UsageStatusItem. - maximum available + The maximum availability of the field. :param max_available: The max_available of this UsageStatusItem. diff --git a/src/oci/log_analytics/models/violation.py b/src/oci/log_analytics/models/violation.py index 1733b2d9d6..2d7a7e5f1c 100644 --- a/src/oci/log_analytics/models/violation.py +++ b/src/oci/log_analytics/models/violation.py @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def indexes(self): """ Gets the indexes of this Violation. - indexes + The indices associated with regular expression violations. :return: The indexes of this Violation. @@ -87,7 +87,7 @@ def indexes(self): def indexes(self, indexes): """ Sets the indexes of this Violation. - indexes + The indices associated with regular expression violations. :param indexes: The indexes of this Violation. @@ -99,7 +99,7 @@ def indexes(self, indexes): def rule_description(self): """ Gets the rule_description of this Violation. - ruleDescription + The rule description. :return: The rule_description of this Violation. @@ -111,7 +111,7 @@ def rule_description(self): def rule_description(self, rule_description): """ Sets the rule_description of this Violation. - ruleDescription + The rule description. :param rule_description: The rule_description of this Violation. @@ -123,7 +123,7 @@ def rule_description(self, rule_description): def rule_name(self): """ Gets the rule_name of this Violation. - ruleName + The rule name. :return: The rule_name of this Violation. @@ -135,7 +135,7 @@ def rule_name(self): def rule_name(self, rule_name): """ Sets the rule_name of this Violation. - ruleName + The rule name. :param rule_name: The rule_name of this Violation. @@ -147,7 +147,7 @@ def rule_name(self, rule_name): def rule_remediation(self): """ Gets the rule_remediation of this Violation. - ruleRemediation + The rule remediation. :return: The rule_remediation of this Violation. @@ -159,7 +159,7 @@ def rule_remediation(self): def rule_remediation(self, rule_remediation): """ Sets the rule_remediation of this Violation. - ruleRemediation + The rule remediation. :param rule_remediation: The rule_remediation of this Violation. @@ -171,7 +171,7 @@ def rule_remediation(self, rule_remediation): def rule_type(self): """ Gets the rule_type of this Violation. - ruleType + The rule type. Either WARN or ERROR. Allowed values for this property are: "WARN", "ERROR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -186,7 +186,7 @@ def rule_type(self): def rule_type(self, rule_type): """ Sets the rule_type of this Violation. - ruleType + The rule type. Either WARN or ERROR. :param rule_type: The rule_type of this Violation. diff --git a/src/oci/mysql/models/__init__.py b/src/oci/mysql/models/__init__.py index 8b7fb86b11..7cdf0301bd 100644 --- a/src/oci/mysql/models/__init__.py +++ b/src/oci/mysql/models/__init__.py @@ -41,6 +41,7 @@ from .create_maintenance_details import CreateMaintenanceDetails from .db_system import DbSystem from .db_system_endpoint import DbSystemEndpoint +from .db_system_placement import DbSystemPlacement from .db_system_snapshot import DbSystemSnapshot from .db_system_source import DbSystemSource from .db_system_source_from_backup import DbSystemSourceFromBackup @@ -117,6 +118,7 @@ "CreateMaintenanceDetails": CreateMaintenanceDetails, "DbSystem": DbSystem, "DbSystemEndpoint": DbSystemEndpoint, + "DbSystemPlacement": DbSystemPlacement, "DbSystemSnapshot": DbSystemSnapshot, "DbSystemSource": DbSystemSource, "DbSystemSourceFromBackup": DbSystemSourceFromBackup, diff --git a/src/oci/mysql/models/configuration_variables.py b/src/oci/mysql/models/configuration_variables.py index 3214fcab60..ca1fbdf19c 100644 --- a/src/oci/mysql/models/configuration_variables.py +++ b/src/oci/mysql/models/configuration_variables.py @@ -57,6 +57,26 @@ class ConfigurationVariables(object): #: This constant has a value of "SERIALIZABLE" TRANSACTION_ISOLATION_SERIALIZABLE = "SERIALIZABLE" + #: A constant which can be used with the group_replication_consistency property of a ConfigurationVariables. + #: This constant has a value of "EVENTUAL" + GROUP_REPLICATION_CONSISTENCY_EVENTUAL = "EVENTUAL" + + #: A constant which can be used with the group_replication_consistency property of a ConfigurationVariables. + #: This constant has a value of "BEFORE_ON_PRIMARY_FAILOVER" + GROUP_REPLICATION_CONSISTENCY_BEFORE_ON_PRIMARY_FAILOVER = "BEFORE_ON_PRIMARY_FAILOVER" + + #: A constant which can be used with the group_replication_consistency property of a ConfigurationVariables. + #: This constant has a value of "BEFORE" + GROUP_REPLICATION_CONSISTENCY_BEFORE = "BEFORE" + + #: A constant which can be used with the group_replication_consistency property of a ConfigurationVariables. + #: This constant has a value of "AFTER" + GROUP_REPLICATION_CONSISTENCY_AFTER = "AFTER" + + #: A constant which can be used with the group_replication_consistency property of a ConfigurationVariables. + #: This constant has a value of "BEFORE_AND_AFTER" + GROUP_REPLICATION_CONSISTENCY_BEFORE_AND_AFTER = "BEFORE_AND_AFTER" + def __init__(self, **kwargs): """ Initializes a new ConfigurationVariables object with values from keyword arguments. @@ -96,6 +116,12 @@ def __init__(self, **kwargs): The value to assign to the foreign_key_checks property of this ConfigurationVariables. :type foreign_key_checks: bool + :param group_replication_consistency: + The value to assign to the group_replication_consistency property of this ConfigurationVariables. + Allowed values for this property are: "EVENTUAL", "BEFORE_ON_PRIMARY_FAILOVER", "BEFORE", "AFTER", "BEFORE_AND_AFTER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type group_replication_consistency: str + :param innodb_ft_enable_stopword: The value to assign to the innodb_ft_enable_stopword property of this ConfigurationVariables. :type innodb_ft_enable_stopword: bool @@ -277,6 +303,7 @@ def __init__(self, **kwargs): 'mandatory_roles': 'str', 'autocommit': 'bool', 'foreign_key_checks': 'bool', + 'group_replication_consistency': 'str', 'innodb_ft_enable_stopword': 'bool', 'local_infile': 'bool', 'mysql_firewall_mode': 'bool', @@ -330,6 +357,7 @@ def __init__(self, **kwargs): 'mandatory_roles': 'mandatoryRoles', 'autocommit': 'autocommit', 'foreign_key_checks': 'foreignKeyChecks', + 'group_replication_consistency': 'groupReplicationConsistency', 'innodb_ft_enable_stopword': 'innodbFtEnableStopword', 'local_infile': 'localInfile', 'mysql_firewall_mode': 'mysqlFirewallMode', @@ -382,6 +410,7 @@ def __init__(self, **kwargs): self._mandatory_roles = None self._autocommit = None self._foreign_key_checks = None + self._group_replication_consistency = None self._innodb_ft_enable_stopword = None self._local_infile = None self._mysql_firewall_mode = None @@ -612,6 +641,92 @@ def foreign_key_checks(self, foreign_key_checks): """ self._foreign_key_checks = foreign_key_checks + @property + def group_replication_consistency(self): + """ + Gets the group_replication_consistency of this ConfigurationVariables. + - EVENTUAL: + Both RO and RW transactions do not wait for preceding transactions to be applied before executing. + A RW transaction does not wait for other members to apply a transaction. This means that a transaction + could be externalized on one member before the others. This also means that in the event of a primary failover, + the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. + RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. + - BEFORE_ON_PRIMARY_FAILOVER: + New RO or RW transactions with a newly elected primary that is applying backlog from the old + primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, + intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that + clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, + but does depend on the size of the backlog. + - BEFORE: + A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding + transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the + latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is + used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. + - AFTER: + A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. + This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or + a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that + applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent + reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, + by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees + provided by BEFORE_ON_PRIMARY_FAILOVER. + - BEFORE_AND_AFTER: + A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been + applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. + This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. + + Allowed values for this property are: "EVENTUAL", "BEFORE_ON_PRIMARY_FAILOVER", "BEFORE", "AFTER", "BEFORE_AND_AFTER", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The group_replication_consistency of this ConfigurationVariables. + :rtype: str + """ + return self._group_replication_consistency + + @group_replication_consistency.setter + def group_replication_consistency(self, group_replication_consistency): + """ + Sets the group_replication_consistency of this ConfigurationVariables. + - EVENTUAL: + Both RO and RW transactions do not wait for preceding transactions to be applied before executing. + A RW transaction does not wait for other members to apply a transaction. This means that a transaction + could be externalized on one member before the others. This also means that in the event of a primary failover, + the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. + RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. + - BEFORE_ON_PRIMARY_FAILOVER: + New RO or RW transactions with a newly elected primary that is applying backlog from the old + primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, + intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that + clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, + but does depend on the size of the backlog. + - BEFORE: + A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding + transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the + latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is + used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. + - AFTER: + A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. + This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or + a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that + applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent + reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, + by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees + provided by BEFORE_ON_PRIMARY_FAILOVER. + - BEFORE_AND_AFTER: + A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been + applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. + This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. + + + :param group_replication_consistency: The group_replication_consistency of this ConfigurationVariables. + :type: str + """ + allowed_values = ["EVENTUAL", "BEFORE_ON_PRIMARY_FAILOVER", "BEFORE", "AFTER", "BEFORE_AND_AFTER"] + if not value_allowed_none_or_none_sentinel(group_replication_consistency, allowed_values): + group_replication_consistency = 'UNKNOWN_ENUM_VALUE' + self._group_replication_consistency = group_replication_consistency + @property def innodb_ft_enable_stopword(self): """ diff --git a/src/oci/mysql/models/create_db_system_details.py b/src/oci/mysql/models/create_db_system_details.py index 3161240710..b7e2e9882b 100644 --- a/src/oci/mysql/models/create_db_system_details.py +++ b/src/oci/mysql/models/create_db_system_details.py @@ -30,6 +30,10 @@ def __init__(self, **kwargs): The value to assign to the compartment_id property of this CreateDbSystemDetails. :type compartment_id: str + :param is_highly_available: + The value to assign to the is_highly_available property of this CreateDbSystemDetails. + :type is_highly_available: bool + :param availability_domain: The value to assign to the availability_domain property of this CreateDbSystemDetails. :type availability_domain: str @@ -107,6 +111,7 @@ def __init__(self, **kwargs): 'display_name': 'str', 'description': 'str', 'compartment_id': 'str', + 'is_highly_available': 'bool', 'availability_domain': 'str', 'fault_domain': 'str', 'configuration_id': 'str', @@ -131,6 +136,7 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'description': 'description', 'compartment_id': 'compartmentId', + 'is_highly_available': 'isHighlyAvailable', 'availability_domain': 'availabilityDomain', 'fault_domain': 'faultDomain', 'configuration_id': 'configurationId', @@ -154,6 +160,7 @@ def __init__(self, **kwargs): self._display_name = None self._description = None self._compartment_id = None + self._is_highly_available = None self._availability_domain = None self._fault_domain = None self._configuration_id = None @@ -245,11 +252,53 @@ def compartment_id(self, compartment_id): """ self._compartment_id = compartment_id + @property + def is_highly_available(self): + """ + Gets the is_highly_available of this CreateDbSystemDetails. + Specifies if the DB System is highly available. + + When creating a DB System with High Availability, three instances + are created and placed according to your region- and + subnet-type. The secondaries are placed automatically in the other + two availability or fault domains. You can choose the preferred + location of your primary instance, only. + + + :return: The is_highly_available of this CreateDbSystemDetails. + :rtype: bool + """ + return self._is_highly_available + + @is_highly_available.setter + def is_highly_available(self, is_highly_available): + """ + Sets the is_highly_available of this CreateDbSystemDetails. + Specifies if the DB System is highly available. + + When creating a DB System with High Availability, three instances + are created and placed according to your region- and + subnet-type. The secondaries are placed automatically in the other + two availability or fault domains. You can choose the preferred + location of your primary instance, only. + + + :param is_highly_available: The is_highly_available of this CreateDbSystemDetails. + :type: bool + """ + self._is_highly_available = is_highly_available + @property def availability_domain(self): """ Gets the availability_domain of this CreateDbSystemDetails. - The Availability Domain where the primary instance should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :return: The availability_domain of this CreateDbSystemDetails. @@ -261,7 +310,13 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateDbSystemDetails. - The Availability Domain where the primary instance should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :param availability_domain: The availability_domain of this CreateDbSystemDetails. @@ -273,7 +328,13 @@ def availability_domain(self, availability_domain): def fault_domain(self): """ Gets the fault_domain of this CreateDbSystemDetails. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :return: The fault_domain of this CreateDbSystemDetails. @@ -285,7 +346,13 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this CreateDbSystemDetails. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :param fault_domain: The fault_domain of this CreateDbSystemDetails. diff --git a/src/oci/mysql/models/db_system.py b/src/oci/mysql/models/db_system.py index bb7aadb520..99f04f1b3b 100644 --- a/src/oci/mysql/models/db_system.py +++ b/src/oci/mysql/models/db_system.py @@ -66,6 +66,14 @@ def __init__(self, **kwargs): The value to assign to the subnet_id property of this DbSystem. :type subnet_id: str + :param is_highly_available: + The value to assign to the is_highly_available property of this DbSystem. + :type is_highly_available: bool + + :param current_placement: + The value to assign to the current_placement property of this DbSystem. + :type current_placement: oci.mysql.models.DbSystemPlacement + :param is_analytics_cluster_attached: The value to assign to the is_analytics_cluster_attached property of this DbSystem. :type is_analytics_cluster_attached: bool @@ -175,6 +183,8 @@ def __init__(self, **kwargs): 'description': 'str', 'compartment_id': 'str', 'subnet_id': 'str', + 'is_highly_available': 'bool', + 'current_placement': 'DbSystemPlacement', 'is_analytics_cluster_attached': 'bool', 'analytics_cluster': 'AnalyticsClusterSummary', 'is_heat_wave_cluster_attached': 'bool', @@ -208,6 +218,8 @@ def __init__(self, **kwargs): 'description': 'description', 'compartment_id': 'compartmentId', 'subnet_id': 'subnetId', + 'is_highly_available': 'isHighlyAvailable', + 'current_placement': 'currentPlacement', 'is_analytics_cluster_attached': 'isAnalyticsClusterAttached', 'analytics_cluster': 'analyticsCluster', 'is_heat_wave_cluster_attached': 'isHeatWaveClusterAttached', @@ -240,6 +252,8 @@ def __init__(self, **kwargs): self._description = None self._compartment_id = None self._subnet_id = None + self._is_highly_available = None + self._current_placement = None self._is_analytics_cluster_attached = None self._analytics_cluster = None self._is_heat_wave_cluster_attached = None @@ -386,6 +400,52 @@ def subnet_id(self, subnet_id): """ self._subnet_id = subnet_id + @property + def is_highly_available(self): + """ + Gets the is_highly_available of this DbSystem. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :return: The is_highly_available of this DbSystem. + :rtype: bool + """ + return self._is_highly_available + + @is_highly_available.setter + def is_highly_available(self, is_highly_available): + """ + Sets the is_highly_available of this DbSystem. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :param is_highly_available: The is_highly_available of this DbSystem. + :type: bool + """ + self._is_highly_available = is_highly_available + + @property + def current_placement(self): + """ + Gets the current_placement of this DbSystem. + + :return: The current_placement of this DbSystem. + :rtype: oci.mysql.models.DbSystemPlacement + """ + return self._current_placement + + @current_placement.setter + def current_placement(self, current_placement): + """ + Sets the current_placement of this DbSystem. + + :param current_placement: The current_placement of this DbSystem. + :type: oci.mysql.models.DbSystemPlacement + """ + self._current_placement = current_placement + @property def is_analytics_cluster_attached(self): """ @@ -480,7 +540,13 @@ def heat_wave_cluster(self, heat_wave_cluster): def availability_domain(self): """ Gets the availability_domain of this DbSystem. - The Availability Domain where the primary DB System should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :return: The availability_domain of this DbSystem. @@ -492,7 +558,13 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this DbSystem. - The Availability Domain where the primary DB System should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :param availability_domain: The availability_domain of this DbSystem. @@ -504,7 +576,13 @@ def availability_domain(self, availability_domain): def fault_domain(self): """ Gets the fault_domain of this DbSystem. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :return: The fault_domain of this DbSystem. @@ -516,7 +594,13 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this DbSystem. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :param fault_domain: The fault_domain of this DbSystem. diff --git a/src/oci/mysql/models/db_system_placement.py b/src/oci/mysql/models/db_system_placement.py new file mode 100644 index 0000000000..72e2464d69 --- /dev/null +++ b/src/oci/mysql/models/db_system_placement.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DbSystemPlacement(object): + """ + The availability domain and fault domain a DB System is placed in. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DbSystemPlacement object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param availability_domain: + The value to assign to the availability_domain property of this DbSystemPlacement. + :type availability_domain: str + + :param fault_domain: + The value to assign to the fault_domain property of this DbSystemPlacement. + :type fault_domain: str + + """ + self.swagger_types = { + 'availability_domain': 'str', + 'fault_domain': 'str' + } + + self.attribute_map = { + 'availability_domain': 'availabilityDomain', + 'fault_domain': 'faultDomain' + } + + self._availability_domain = None + self._fault_domain = None + + @property + def availability_domain(self): + """ + Gets the availability_domain of this DbSystemPlacement. + The availability domain in which the DB System is placed. + + + :return: The availability_domain of this DbSystemPlacement. + :rtype: str + """ + return self._availability_domain + + @availability_domain.setter + def availability_domain(self, availability_domain): + """ + Sets the availability_domain of this DbSystemPlacement. + The availability domain in which the DB System is placed. + + + :param availability_domain: The availability_domain of this DbSystemPlacement. + :type: str + """ + self._availability_domain = availability_domain + + @property + def fault_domain(self): + """ + Gets the fault_domain of this DbSystemPlacement. + The fault domain in which the DB System is placed. + + + :return: The fault_domain of this DbSystemPlacement. + :rtype: str + """ + return self._fault_domain + + @fault_domain.setter + def fault_domain(self, fault_domain): + """ + Sets the fault_domain of this DbSystemPlacement. + The fault domain in which the DB System is placed. + + + :param fault_domain: The fault_domain of this DbSystemPlacement. + :type: str + """ + self._fault_domain = fault_domain + + 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/mysql/models/db_system_snapshot.py b/src/oci/mysql/models/db_system_snapshot.py index 123a6d6bfe..d8b157dd12 100644 --- a/src/oci/mysql/models/db_system_snapshot.py +++ b/src/oci/mysql/models/db_system_snapshot.py @@ -86,6 +86,10 @@ def __init__(self, **kwargs): The value to assign to the port_x property of this DbSystemSnapshot. :type port_x: int + :param is_highly_available: + The value to assign to the is_highly_available property of this DbSystemSnapshot. + :type is_highly_available: bool + :param endpoints: The value to assign to the endpoints property of this DbSystemSnapshot. :type endpoints: list[oci.mysql.models.DbSystemEndpoint] @@ -121,6 +125,7 @@ def __init__(self, **kwargs): 'ip_address': 'str', 'port': 'int', 'port_x': 'int', + 'is_highly_available': 'bool', 'endpoints': 'list[DbSystemEndpoint]', 'maintenance': 'MaintenanceDetails', 'freeform_tags': 'dict(str, str)', @@ -145,6 +150,7 @@ def __init__(self, **kwargs): 'ip_address': 'ipAddress', 'port': 'port', 'port_x': 'portX', + 'is_highly_available': 'isHighlyAvailable', 'endpoints': 'endpoints', 'maintenance': 'maintenance', 'freeform_tags': 'freeformTags', @@ -168,6 +174,7 @@ def __init__(self, **kwargs): self._ip_address = None self._port = None self._port_x = None + self._is_highly_available = None self._endpoints = None self._maintenance = None self._freeform_tags = None @@ -597,6 +604,32 @@ def port_x(self, port_x): """ self._port_x = port_x + @property + def is_highly_available(self): + """ + Gets the is_highly_available of this DbSystemSnapshot. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :return: The is_highly_available of this DbSystemSnapshot. + :rtype: bool + """ + return self._is_highly_available + + @is_highly_available.setter + def is_highly_available(self, is_highly_available): + """ + Sets the is_highly_available of this DbSystemSnapshot. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :param is_highly_available: The is_highly_available of this DbSystemSnapshot. + :type: bool + """ + self._is_highly_available = is_highly_available + @property def endpoints(self): """ diff --git a/src/oci/mysql/models/db_system_summary.py b/src/oci/mysql/models/db_system_summary.py index 6b881b257d..241b8c6e13 100644 --- a/src/oci/mysql/models/db_system_summary.py +++ b/src/oci/mysql/models/db_system_summary.py @@ -34,6 +34,14 @@ def __init__(self, **kwargs): The value to assign to the compartment_id property of this DbSystemSummary. :type compartment_id: str + :param is_highly_available: + The value to assign to the is_highly_available property of this DbSystemSummary. + :type is_highly_available: bool + + :param current_placement: + The value to assign to the current_placement property of this DbSystemSummary. + :type current_placement: oci.mysql.models.DbSystemPlacement + :param is_analytics_cluster_attached: The value to assign to the is_analytics_cluster_attached property of this DbSystemSummary. :type is_analytics_cluster_attached: bool @@ -92,6 +100,8 @@ def __init__(self, **kwargs): 'display_name': 'str', 'description': 'str', 'compartment_id': 'str', + 'is_highly_available': 'bool', + 'current_placement': 'DbSystemPlacement', 'is_analytics_cluster_attached': 'bool', 'analytics_cluster': 'AnalyticsClusterSummary', 'is_heat_wave_cluster_attached': 'bool', @@ -112,6 +122,8 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'description': 'description', 'compartment_id': 'compartmentId', + 'is_highly_available': 'isHighlyAvailable', + 'current_placement': 'currentPlacement', 'is_analytics_cluster_attached': 'isAnalyticsClusterAttached', 'analytics_cluster': 'analyticsCluster', 'is_heat_wave_cluster_attached': 'isHeatWaveClusterAttached', @@ -131,6 +143,8 @@ def __init__(self, **kwargs): self._display_name = None self._description = None self._compartment_id = None + self._is_highly_available = None + self._current_placement = None self._is_analytics_cluster_attached = None self._analytics_cluster = None self._is_heat_wave_cluster_attached = None @@ -241,6 +255,52 @@ def compartment_id(self, compartment_id): """ self._compartment_id = compartment_id + @property + def is_highly_available(self): + """ + Gets the is_highly_available of this DbSystemSummary. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :return: The is_highly_available of this DbSystemSummary. + :rtype: bool + """ + return self._is_highly_available + + @is_highly_available.setter + def is_highly_available(self, is_highly_available): + """ + Sets the is_highly_available of this DbSystemSummary. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :param is_highly_available: The is_highly_available of this DbSystemSummary. + :type: bool + """ + self._is_highly_available = is_highly_available + + @property + def current_placement(self): + """ + Gets the current_placement of this DbSystemSummary. + + :return: The current_placement of this DbSystemSummary. + :rtype: oci.mysql.models.DbSystemPlacement + """ + return self._current_placement + + @current_placement.setter + def current_placement(self, current_placement): + """ + Sets the current_placement of this DbSystemSummary. + + :param current_placement: The current_placement of this DbSystemSummary. + :type: oci.mysql.models.DbSystemPlacement + """ + self._current_placement = current_placement + @property def is_analytics_cluster_attached(self): """ @@ -335,7 +395,13 @@ def heat_wave_cluster(self, heat_wave_cluster): def availability_domain(self): """ Gets the availability_domain of this DbSystemSummary. - The Availability Domain where the primary DB System should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :return: The availability_domain of this DbSystemSummary. @@ -347,7 +413,13 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this DbSystemSummary. - The Availability Domain where the primary DB System should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :param availability_domain: The availability_domain of this DbSystemSummary. @@ -359,7 +431,13 @@ def availability_domain(self, availability_domain): def fault_domain(self): """ Gets the fault_domain of this DbSystemSummary. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :return: The fault_domain of this DbSystemSummary. @@ -371,7 +449,13 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this DbSystemSummary. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :param fault_domain: The fault_domain of this DbSystemSummary. diff --git a/src/oci/mysql/models/update_db_system_details.py b/src/oci/mysql/models/update_db_system_details.py index e649c428b6..d38ec4ceb0 100644 --- a/src/oci/mysql/models/update_db_system_details.py +++ b/src/oci/mysql/models/update_db_system_details.py @@ -30,6 +30,10 @@ def __init__(self, **kwargs): The value to assign to the subnet_id property of this UpdateDbSystemDetails. :type subnet_id: str + :param is_highly_available: + The value to assign to the is_highly_available property of this UpdateDbSystemDetails. + :type is_highly_available: bool + :param availability_domain: The value to assign to the availability_domain property of this UpdateDbSystemDetails. :type availability_domain: str @@ -99,6 +103,7 @@ def __init__(self, **kwargs): 'display_name': 'str', 'description': 'str', 'subnet_id': 'str', + 'is_highly_available': 'bool', 'availability_domain': 'str', 'fault_domain': 'str', 'shape_name': 'str', @@ -121,6 +126,7 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'description': 'description', 'subnet_id': 'subnetId', + 'is_highly_available': 'isHighlyAvailable', 'availability_domain': 'availabilityDomain', 'fault_domain': 'faultDomain', 'shape_name': 'shapeName', @@ -142,6 +148,7 @@ def __init__(self, **kwargs): self._display_name = None self._description = None self._subnet_id = None + self._is_highly_available = None self._availability_domain = None self._fault_domain = None self._shape_name = None @@ -231,11 +238,43 @@ def subnet_id(self, subnet_id): """ self._subnet_id = subnet_id + @property + def is_highly_available(self): + """ + Gets the is_highly_available of this UpdateDbSystemDetails. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :return: The is_highly_available of this UpdateDbSystemDetails. + :rtype: bool + """ + return self._is_highly_available + + @is_highly_available.setter + def is_highly_available(self, is_highly_available): + """ + Sets the is_highly_available of this UpdateDbSystemDetails. + If the policy is to enable high availability of the instance, by + maintaining secondary/failover capacity as necessary. + + + :param is_highly_available: The is_highly_available of this UpdateDbSystemDetails. + :type: bool + """ + self._is_highly_available = is_highly_available + @property def availability_domain(self): """ Gets the availability_domain of this UpdateDbSystemDetails. - The Availability Domain where the primary instance should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :return: The availability_domain of this UpdateDbSystemDetails. @@ -247,7 +286,13 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this UpdateDbSystemDetails. - The Availability Domain where the primary instance should be located. + The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the availability domain in which the DB System is placed. :param availability_domain: The availability_domain of this UpdateDbSystemDetails. @@ -259,7 +304,13 @@ def availability_domain(self, availability_domain): def fault_domain(self): """ Gets the fault_domain of this UpdateDbSystemDetails. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :return: The fault_domain of this UpdateDbSystemDetails. @@ -271,7 +322,13 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this UpdateDbSystemDetails. - The name of the Fault Domain the DB System is located in. + The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. + + In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains + and the MySQL instance in that domain is promoted to the primary instance. + This redirection does not affect the IP address of the DB System in any way. + + For a standalone DB System, this defines the fault domain in which the DB System is placed. :param fault_domain: The fault_domain of this UpdateDbSystemDetails. diff --git a/src/oci/object_storage/transfer/internal/multipart_object_assembler.py b/src/oci/object_storage/transfer/internal/multipart_object_assembler.py index e5bf988a03..7001c49b4d 100644 --- a/src/oci/object_storage/transfer/internal/multipart_object_assembler.py +++ b/src/oci/object_storage/transfer/internal/multipart_object_assembler.py @@ -426,9 +426,9 @@ def _upload_part(self, part_num, part, **kwargs): retry_strategy = kwargs['retry_strategy'] if "opc_md5" not in part: - # Disable the retry_strategy to work around data corruption issue temporarily - retry_strategy = None + # A call to _upload_part_call can be retried because it reads the same data into the + # body as BufferedPartReader every time before calling put_object, using the kwargs "offset" and "size" if retry_strategy: response = retry_strategy.make_retrying_call( self._upload_part_call, @@ -444,8 +444,7 @@ def _upload_part(self, part_num, part, **kwargs): new_kwargs=new_kwargs ) else: - # Disable the retry_strategy to work around data corruption issue temporarily - remaining_tries = 1 + remaining_tries = self.max_retries while remaining_tries > 0: try: response = self._upload_part_call(self.object_storage_client, @@ -482,6 +481,8 @@ def _upload_stream_part(self, part_num, part_bytes, **kwargs): if 'opc_client_request_id' in kwargs: new_kwargs['opc_client_request_id'] = kwargs['opc_client_request_id'] + # A call to upload_part can be retried because we've already read() the data and retrying the + # request with same data part_bytes remaining_tries = self.max_retries while remaining_tries > 0: try: diff --git a/src/oci/ocvp/esxi_host_client.py b/src/oci/ocvp/esxi_host_client.py index 6927de1847..36c37c457a 100644 --- a/src/oci/ocvp/esxi_host_client.py +++ b/src/oci/ocvp/esxi_host_client.py @@ -18,7 +18,7 @@ class EsxiHostClient(object): """ - Use this API to manage the Oracle Cloud VMware Solution. + Use this API to manage your [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm). """ def __init__(self, config, **kwargs): diff --git a/src/oci/ocvp/models/create_sddc_details.py b/src/oci/ocvp/models/create_sddc_details.py index 8fffe6b2d9..33056036a3 100644 --- a/src/oci/ocvp/models/create_sddc_details.py +++ b/src/oci/ocvp/models/create_sddc_details.py @@ -90,6 +90,14 @@ def __init__(self, **kwargs): The value to assign to the nsx_edge_uplink2_vlan_id property of this CreateSddcDetails. :type nsx_edge_uplink2_vlan_id: str + :param replication_vlan_id: + The value to assign to the replication_vlan_id property of this CreateSddcDetails. + :type replication_vlan_id: str + + :param provisioning_vlan_id: + The value to assign to the provisioning_vlan_id property of this CreateSddcDetails. + :type provisioning_vlan_id: str + :param freeform_tags: The value to assign to the freeform_tags property of this CreateSddcDetails. :type freeform_tags: dict(str, str) @@ -118,6 +126,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'str', 'nsx_edge_uplink1_vlan_id': 'str', 'nsx_edge_uplink2_vlan_id': 'str', + 'replication_vlan_id': 'str', + 'provisioning_vlan_id': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -141,6 +151,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'nsxEdgeVTepVlanId', 'nsx_edge_uplink1_vlan_id': 'nsxEdgeUplink1VlanId', 'nsx_edge_uplink2_vlan_id': 'nsxEdgeUplink2VlanId', + 'replication_vlan_id': 'replicationVlanId', + 'provisioning_vlan_id': 'provisioningVlanId', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } @@ -163,6 +175,8 @@ def __init__(self, **kwargs): self._nsx_edge_v_tep_vlan_id = None self._nsx_edge_uplink1_vlan_id = None self._nsx_edge_uplink2_vlan_id = None + self._replication_vlan_id = None + self._provisioning_vlan_id = None self._freeform_tags = None self._defined_tags = None @@ -224,8 +238,7 @@ def vmware_software_version(self): **[Required]** Gets the vmware_software_version of this CreateSddcDetails. The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use - :func:` - _list_supported_vmware_software_versions`. + :func:`list_supported_vmware_software_versions`. :return: The vmware_software_version of this CreateSddcDetails. @@ -239,8 +252,7 @@ def vmware_software_version(self, vmware_software_version): Sets the vmware_software_version of this CreateSddcDetails. The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use - :func:` - _list_supported_vmware_software_versions`. + :func:`list_supported_vmware_software_versions`. :param vmware_software_version: The vmware_software_version of this CreateSddcDetails. @@ -348,7 +360,7 @@ def esxi_hosts_count(self, esxi_hosts_count): def is_hcx_enabled(self): """ Gets the is_hcx_enabled of this CreateSddcDetails. - This flag tells us if HCX is enabled or not. + Indicates whether to enable HCX for this SDDC. :return: The is_hcx_enabled of this CreateSddcDetails. @@ -360,7 +372,7 @@ def is_hcx_enabled(self): def is_hcx_enabled(self, is_hcx_enabled): """ Sets the is_hcx_enabled of this CreateSddcDetails. - This flag tells us if HCX is enabled or not. + Indicates whether to enable HCX for this SDDC. :param is_hcx_enabled: The is_hcx_enabled of this CreateSddcDetails. @@ -372,7 +384,10 @@ def is_hcx_enabled(self, is_hcx_enabled): def hcx_vlan_id(self): """ Gets the hcx_vlan_id of this CreateSddcDetails. - This id is required only when hcxEnabled is true + The `OCID`__ of the VLAN to use for the HCX + component of the VMware environment. This value is required only when `isHcxEnabled` is true. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The hcx_vlan_id of this CreateSddcDetails. @@ -384,7 +399,10 @@ def hcx_vlan_id(self): def hcx_vlan_id(self, hcx_vlan_id): """ Sets the hcx_vlan_id of this CreateSddcDetails. - This id is required only when hcxEnabled is true + The `OCID`__ of the VLAN to use for the HCX + component of the VMware environment. This value is required only when `isHcxEnabled` is true. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param hcx_vlan_id: The hcx_vlan_id of this CreateSddcDetails. @@ -663,6 +681,8 @@ def nsx_edge_uplink2_vlan_id(self): The `OCID`__ of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment. + **Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -678,6 +698,8 @@ def nsx_edge_uplink2_vlan_id(self, nsx_edge_uplink2_vlan_id): The `OCID`__ of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment. + **Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -686,6 +708,66 @@ def nsx_edge_uplink2_vlan_id(self, nsx_edge_uplink2_vlan_id): """ self._nsx_edge_uplink2_vlan_id = nsx_edge_uplink2_vlan_id + @property + def replication_vlan_id(self): + """ + Gets the replication_vlan_id of this CreateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The replication_vlan_id of this CreateSddcDetails. + :rtype: str + """ + return self._replication_vlan_id + + @replication_vlan_id.setter + def replication_vlan_id(self, replication_vlan_id): + """ + Sets the replication_vlan_id of this CreateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param replication_vlan_id: The replication_vlan_id of this CreateSddcDetails. + :type: str + """ + self._replication_vlan_id = replication_vlan_id + + @property + def provisioning_vlan_id(self): + """ + Gets the provisioning_vlan_id of this CreateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The provisioning_vlan_id of this CreateSddcDetails. + :rtype: str + """ + return self._provisioning_vlan_id + + @provisioning_vlan_id.setter + def provisioning_vlan_id(self, provisioning_vlan_id): + """ + Sets the provisioning_vlan_id of this CreateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param provisioning_vlan_id: The provisioning_vlan_id of this CreateSddcDetails. + :type: str + """ + self._provisioning_vlan_id = provisioning_vlan_id + @property def freeform_tags(self): """ diff --git a/src/oci/ocvp/models/sddc.py b/src/oci/ocvp/models/sddc.py index 034f55dfc5..09e7f3bcdd 100644 --- a/src/oci/ocvp/models/sddc.py +++ b/src/oci/ocvp/models/sddc.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Sddc(object): """ - A software-defined data center (SDDC) contains the resources required for a + An `Oracle Cloud VMware Solution`__ software-defined data center (SDDC) contains the resources required for a functional VMware environment. Instances in an SDDC (see :class:`EsxiHost`) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage @@ -19,6 +19,8 @@ class Sddc(object): The SDDC uses a single management subnet for provisioning the SDDC. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs. + + __ https://docs.cloud.oracle.com/iaas/Content/VMware/Concepts/ocvsoverview.htm """ #: A constant which can be used with the lifecycle_state property of a Sddc. @@ -158,6 +160,14 @@ def __init__(self, **kwargs): The value to assign to the nsx_edge_uplink2_vlan_id property of this Sddc. :type nsx_edge_uplink2_vlan_id: str + :param replication_vlan_id: + The value to assign to the replication_vlan_id property of this Sddc. + :type replication_vlan_id: str + + :param provisioning_vlan_id: + The value to assign to the provisioning_vlan_id property of this Sddc. + :type provisioning_vlan_id: str + :param hcx_private_ip_id: The value to assign to the hcx_private_ip_id property of this Sddc. :type hcx_private_ip_id: str @@ -233,6 +243,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'str', 'nsx_edge_uplink1_vlan_id': 'str', 'nsx_edge_uplink2_vlan_id': 'str', + 'replication_vlan_id': 'str', + 'provisioning_vlan_id': 'str', 'hcx_private_ip_id': 'str', 'hcx_fqdn': 'str', 'hcx_initial_password': 'str', @@ -274,6 +286,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'nsxEdgeVTepVlanId', 'nsx_edge_uplink1_vlan_id': 'nsxEdgeUplink1VlanId', 'nsx_edge_uplink2_vlan_id': 'nsxEdgeUplink2VlanId', + 'replication_vlan_id': 'replicationVlanId', + 'provisioning_vlan_id': 'provisioningVlanId', 'hcx_private_ip_id': 'hcxPrivateIpId', 'hcx_fqdn': 'hcxFqdn', 'hcx_initial_password': 'hcxInitialPassword', @@ -314,6 +328,8 @@ def __init__(self, **kwargs): self._nsx_edge_v_tep_vlan_id = None self._nsx_edge_uplink1_vlan_id = None self._nsx_edge_uplink2_vlan_id = None + self._replication_vlan_id = None + self._provisioning_vlan_id = None self._hcx_private_ip_id = None self._hcx_fqdn = None self._hcx_initial_password = None @@ -448,8 +464,7 @@ def vmware_software_version(self): **[Required]** Gets the vmware_software_version of this Sddc. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose @@ -474,8 +489,7 @@ def vmware_software_version(self, vmware_software_version): Sets the vmware_software_version of this Sddc. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose @@ -552,7 +566,7 @@ def esxi_hosts_count(self, esxi_hosts_count): def vcenter_fqdn(self): """ **[Required]** Gets the vcenter_fqdn of this Sddc. - FQDN for vCenter + The FQDN for vCenter. Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com` @@ -566,7 +580,7 @@ def vcenter_fqdn(self): def vcenter_fqdn(self, vcenter_fqdn): """ Sets the vcenter_fqdn of this Sddc. - FQDN for vCenter + The FQDN for vCenter. Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com` @@ -580,7 +594,7 @@ def vcenter_fqdn(self, vcenter_fqdn): def nsx_manager_fqdn(self): """ **[Required]** Gets the nsx_manager_fqdn of this Sddc. - FQDN for NSX Manager + The FQDN for NSX Manager. Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` @@ -594,7 +608,7 @@ def nsx_manager_fqdn(self): def nsx_manager_fqdn(self, nsx_manager_fqdn): """ Sets the nsx_manager_fqdn of this Sddc. - FQDN for NSX Manager + The FQDN for NSX Manager. Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` @@ -1300,11 +1314,75 @@ def nsx_edge_uplink2_vlan_id(self, nsx_edge_uplink2_vlan_id): """ self._nsx_edge_uplink2_vlan_id = nsx_edge_uplink2_vlan_id + @property + def replication_vlan_id(self): + """ + Gets the replication_vlan_id of this Sddc. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The replication_vlan_id of this Sddc. + :rtype: str + """ + return self._replication_vlan_id + + @replication_vlan_id.setter + def replication_vlan_id(self, replication_vlan_id): + """ + Sets the replication_vlan_id of this Sddc. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param replication_vlan_id: The replication_vlan_id of this Sddc. + :type: str + """ + self._replication_vlan_id = replication_vlan_id + + @property + def provisioning_vlan_id(self): + """ + Gets the provisioning_vlan_id of this Sddc. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The provisioning_vlan_id of this Sddc. + :rtype: str + """ + return self._provisioning_vlan_id + + @provisioning_vlan_id.setter + def provisioning_vlan_id(self, provisioning_vlan_id): + """ + Sets the provisioning_vlan_id of this Sddc. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param provisioning_vlan_id: The provisioning_vlan_id of this Sddc. + :type: str + """ + self._provisioning_vlan_id = provisioning_vlan_id + @property def hcx_private_ip_id(self): """ Gets the hcx_private_ip_id of this Sddc. - HCX Private IP + The `OCID`__ of the `PrivateIp` object that is + the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the + Core Services API. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The hcx_private_ip_id of this Sddc. @@ -1316,7 +1394,11 @@ def hcx_private_ip_id(self): def hcx_private_ip_id(self, hcx_private_ip_id): """ Sets the hcx_private_ip_id of this Sddc. - HCX Private IP + The `OCID`__ of the `PrivateIp` object that is + the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the + Core Services API. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param hcx_private_ip_id: The hcx_private_ip_id of this Sddc. @@ -1328,7 +1410,9 @@ def hcx_private_ip_id(self, hcx_private_ip_id): def hcx_fqdn(self): """ Gets the hcx_fqdn of this Sddc. - HCX Fully Qualified Domain Name + The FQDN for HCX Manager. + + Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` :return: The hcx_fqdn of this Sddc. @@ -1340,7 +1424,9 @@ def hcx_fqdn(self): def hcx_fqdn(self, hcx_fqdn): """ Sets the hcx_fqdn of this Sddc. - HCX Fully Qualified Domain Name + The FQDN for HCX Manager. + + Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` :param hcx_fqdn: The hcx_fqdn of this Sddc. @@ -1352,7 +1438,8 @@ def hcx_fqdn(self, hcx_fqdn): def hcx_initial_password(self): """ Gets the hcx_initial_password of this Sddc. - HCX initial password + The SDDC includes an administrator username and initial password for HCX Manager. Make sure + to change this initial HCX Manager password to a different value. :return: The hcx_initial_password of this Sddc. @@ -1364,7 +1451,8 @@ def hcx_initial_password(self): def hcx_initial_password(self, hcx_initial_password): """ Sets the hcx_initial_password of this Sddc. - HCX initial password + The SDDC includes an administrator username and initial password for HCX Manager. Make sure + to change this initial HCX Manager password to a different value. :param hcx_initial_password: The hcx_initial_password of this Sddc. @@ -1376,7 +1464,21 @@ def hcx_initial_password(self, hcx_initial_password): def hcx_vlan_id(self): """ Gets the hcx_vlan_id of this Sddc. - HCX vlan id + The `OCID`__ of the VLAN used by the SDDC + for the HCX component of the VMware environment. + + This attribute is not guaranteed to reflect the HCX VLAN + currently used by the ESXi hosts in the SDDC. The purpose + of this attribute is to show the HCX VLAN that the Oracle + Cloud VMware Solution will use for any new ESXi hosts that you *add to this + SDDC in the future* with :func:`create_esxi_host`. + + Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN + for the HCX component of the VMware environment, you + should use :func:`update_sddc` to update the SDDC's + `hcxVlanId` with that new VLAN's OCID. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The hcx_vlan_id of this Sddc. @@ -1388,7 +1490,21 @@ def hcx_vlan_id(self): def hcx_vlan_id(self, hcx_vlan_id): """ Sets the hcx_vlan_id of this Sddc. - HCX vlan id + The `OCID`__ of the VLAN used by the SDDC + for the HCX component of the VMware environment. + + This attribute is not guaranteed to reflect the HCX VLAN + currently used by the ESXi hosts in the SDDC. The purpose + of this attribute is to show the HCX VLAN that the Oracle + Cloud VMware Solution will use for any new ESXi hosts that you *add to this + SDDC in the future* with :func:`create_esxi_host`. + + Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN + for the HCX component of the VMware environment, you + should use :func:`update_sddc` to update the SDDC's + `hcxVlanId` with that new VLAN's OCID. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param hcx_vlan_id: The hcx_vlan_id of this Sddc. @@ -1400,7 +1516,7 @@ def hcx_vlan_id(self, hcx_vlan_id): def is_hcx_enabled(self): """ Gets the is_hcx_enabled of this Sddc. - HCX enabled or not + Indicates whether HCX is enabled for this SDDC. :return: The is_hcx_enabled of this Sddc. @@ -1412,7 +1528,7 @@ def is_hcx_enabled(self): def is_hcx_enabled(self, is_hcx_enabled): """ Sets the is_hcx_enabled of this Sddc. - HCX enabled or not + Indicates whether HCX is enabled for this SDDC. :param is_hcx_enabled: The is_hcx_enabled of this Sddc. @@ -1424,7 +1540,8 @@ def is_hcx_enabled(self, is_hcx_enabled): def hcx_on_prem_key(self): """ Gets the hcx_on_prem_key of this Sddc. - HCX on-premise license key + The activation key to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution. + Your implementation might need more than one activation key. To obtain additional keys, contact Oracle Support. :return: The hcx_on_prem_key of this Sddc. @@ -1436,7 +1553,8 @@ def hcx_on_prem_key(self): def hcx_on_prem_key(self, hcx_on_prem_key): """ Sets the hcx_on_prem_key of this Sddc. - HCX on-premise license key + The activation key to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution. + Your implementation might need more than one activation key. To obtain additional keys, contact Oracle Support. :param hcx_on_prem_key: The hcx_on_prem_key of this Sddc. diff --git a/src/oci/ocvp/models/sddc_summary.py b/src/oci/ocvp/models/sddc_summary.py index dabeddd775..f9ca99ff13 100644 --- a/src/oci/ocvp/models/sddc_summary.py +++ b/src/oci/ocvp/models/sddc_summary.py @@ -245,8 +245,7 @@ def vmware_software_version(self): **[Required]** Gets the vmware_software_version of this SddcSummary. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose @@ -271,8 +270,7 @@ def vmware_software_version(self, vmware_software_version): Sets the vmware_software_version of this SddcSummary. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose diff --git a/src/oci/ocvp/models/update_sddc_details.py b/src/oci/ocvp/models/update_sddc_details.py index 257c2a0966..152e96d5d8 100644 --- a/src/oci/ocvp/models/update_sddc_details.py +++ b/src/oci/ocvp/models/update_sddc_details.py @@ -64,6 +64,14 @@ def __init__(self, **kwargs): The value to assign to the nsx_edge_uplink2_vlan_id property of this UpdateSddcDetails. :type nsx_edge_uplink2_vlan_id: str + :param replication_vlan_id: + The value to assign to the replication_vlan_id property of this UpdateSddcDetails. + :type replication_vlan_id: str + + :param provisioning_vlan_id: + The value to assign to the provisioning_vlan_id property of this UpdateSddcDetails. + :type provisioning_vlan_id: str + :param hcx_vlan_id: The value to assign to the hcx_vlan_id property of this UpdateSddcDetails. :type hcx_vlan_id: str @@ -88,6 +96,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'str', 'nsx_edge_uplink1_vlan_id': 'str', 'nsx_edge_uplink2_vlan_id': 'str', + 'replication_vlan_id': 'str', + 'provisioning_vlan_id': 'str', 'hcx_vlan_id': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' @@ -104,6 +114,8 @@ def __init__(self, **kwargs): 'nsx_edge_v_tep_vlan_id': 'nsxEdgeVTepVlanId', 'nsx_edge_uplink1_vlan_id': 'nsxEdgeUplink1VlanId', 'nsx_edge_uplink2_vlan_id': 'nsxEdgeUplink2VlanId', + 'replication_vlan_id': 'replicationVlanId', + 'provisioning_vlan_id': 'provisioningVlanId', 'hcx_vlan_id': 'hcxVlanId', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' @@ -119,6 +131,8 @@ def __init__(self, **kwargs): self._nsx_edge_v_tep_vlan_id = None self._nsx_edge_uplink1_vlan_id = None self._nsx_edge_uplink2_vlan_id = None + self._replication_vlan_id = None + self._provisioning_vlan_id = None self._hcx_vlan_id = None self._freeform_tags = None self._defined_tags = None @@ -161,8 +175,7 @@ def vmware_software_version(self): install on any new ESXi hosts that you add to this SDDC in the future. For the list of versions supported by the Oracle Cloud VMware Solution, see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). :return: The vmware_software_version of this UpdateSddcDetails. @@ -178,8 +191,7 @@ def vmware_software_version(self, vmware_software_version): install on any new ESXi hosts that you add to this SDDC in the future. For the list of versions supported by the Oracle Cloud VMware Solution, see - :func:` - _list_supported_vmware_software_versions`). + :func:`list_supported_vmware_software_versions`). :param vmware_software_version: The vmware_software_version of this UpdateSddcDetails. @@ -404,6 +416,8 @@ def nsx_edge_uplink2_vlan_id(self): The `OCID`__ of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment when adding new ESXi hosts to the SDDC. + **Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -419,6 +433,8 @@ def nsx_edge_uplink2_vlan_id(self, nsx_edge_uplink2_vlan_id): The `OCID`__ of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment when adding new ESXi hosts to the SDDC. + **Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -427,11 +443,74 @@ def nsx_edge_uplink2_vlan_id(self, nsx_edge_uplink2_vlan_id): """ self._nsx_edge_uplink2_vlan_id = nsx_edge_uplink2_vlan_id + @property + def replication_vlan_id(self): + """ + Gets the replication_vlan_id of this UpdateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The replication_vlan_id of this UpdateSddcDetails. + :rtype: str + """ + return self._replication_vlan_id + + @replication_vlan_id.setter + def replication_vlan_id(self, replication_vlan_id): + """ + Sets the replication_vlan_id of this UpdateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the vSphere Replication component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param replication_vlan_id: The replication_vlan_id of this UpdateSddcDetails. + :type: str + """ + self._replication_vlan_id = replication_vlan_id + + @property + def provisioning_vlan_id(self): + """ + Gets the provisioning_vlan_id of this UpdateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The provisioning_vlan_id of this UpdateSddcDetails. + :rtype: str + """ + return self._provisioning_vlan_id + + @provisioning_vlan_id.setter + def provisioning_vlan_id(self, provisioning_vlan_id): + """ + Sets the provisioning_vlan_id of this UpdateSddcDetails. + The `OCID`__ of the VLAN used by the SDDC + for the Provisioning component of the VMware environment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param provisioning_vlan_id: The provisioning_vlan_id of this UpdateSddcDetails. + :type: str + """ + self._provisioning_vlan_id = provisioning_vlan_id + @property def hcx_vlan_id(self): """ Gets the hcx_vlan_id of this UpdateSddcDetails. - This id is editable only when hcxEnabled is true + The `OCID`__ of the VLAN to use for the HCX + component of the VMware environment when adding new ESXi hosts to the SDDC. This value can be updated only when `isHcxEnabled` is true. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The hcx_vlan_id of this UpdateSddcDetails. @@ -443,7 +522,10 @@ def hcx_vlan_id(self): def hcx_vlan_id(self, hcx_vlan_id): """ Sets the hcx_vlan_id of this UpdateSddcDetails. - This id is editable only when hcxEnabled is true + The `OCID`__ of the VLAN to use for the HCX + component of the VMware environment when adding new ESXi hosts to the SDDC. This value can be updated only when `isHcxEnabled` is true. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param hcx_vlan_id: The hcx_vlan_id of this UpdateSddcDetails. diff --git a/src/oci/ocvp/sddc_client.py b/src/oci/ocvp/sddc_client.py index 11f2d616d8..178de41ba0 100644 --- a/src/oci/ocvp/sddc_client.py +++ b/src/oci/ocvp/sddc_client.py @@ -18,7 +18,7 @@ class SddcClient(object): """ - Use this API to manage the Oracle Cloud VMware Solution. + Use this API to manage your [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm). """ def __init__(self, config, **kwargs): @@ -192,11 +192,15 @@ def change_sddc_compartment(self, sddc_id, change_sddc_compartment_details, **kw def create_sddc(self, create_sddc_details, **kwargs): """ - Creates a software-defined data center (SDDC). + Creates an Oracle Cloud VMware Solution software-defined data center (SDDC). Use the :class:`WorkRequest` operations to track the creation of the SDDC. + **Important:** You must configure the SDDC's networking resources with the security rules detailed in `Security Rules for Oracle Cloud VMware Solution SDDCs`__. Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware. + + __ https://docs.cloud.oracle.com/iaas/Content/VMware/Reference/ocvssecurityrules.htm + :param oci.ocvp.models.CreateSddcDetails create_sddc_details: (required) Details for the SDDC. diff --git a/src/oci/ocvp/work_request_client.py b/src/oci/ocvp/work_request_client.py index fbfb9cd07a..b75a7554f8 100644 --- a/src/oci/ocvp/work_request_client.py +++ b/src/oci/ocvp/work_request_client.py @@ -18,7 +18,7 @@ class WorkRequestClient(object): """ - Use this API to manage the Oracle Cloud VMware Solution. + Use this API to manage your [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm). """ def __init__(self, config, **kwargs): diff --git a/src/oci/usage_api/models/dimension.py b/src/oci/usage_api/models/dimension.py index 0dbd8b3aa9..4a1f6605f0 100644 --- a/src/oci/usage_api/models/dimension.py +++ b/src/oci/usage_api/models/dimension.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class Dimension(object): """ - The dimension used for filtering. availabe dimension are \"service\", \"skuName\", \"skuPartNumber\", \"unit\", \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\", \"resourceId\", \"tenantId\", \"tenantName\" - example: + The dimension used for filtering. Availabe dimensions are: \"service\", \"skuName\", \"skuPartNumber\", \"unit\", \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\", \"resourceId\", \"tenantId\", \"tenantName\". + For example: `[{value: \"COMPUTE\", key: \"service\"}]` """ diff --git a/src/oci/usage_api/models/forecast.py b/src/oci/usage_api/models/forecast.py index 4213161225..37337e7538 100644 --- a/src/oci/usage_api/models/forecast.py +++ b/src/oci/usage_api/models/forecast.py @@ -10,22 +10,23 @@ @init_model_state_from_kwargs class Forecast(object): """ - Forcast configuration of usage/cost. + Forecast configuration of usage/cost. """ - #: A constant which can be used with the forcast_type property of a Forecast. + #: A constant which can be used with the forecast_type property of a Forecast. #: This constant has a value of "BASIC" - FORCAST_TYPE_BASIC = "BASIC" + FORECAST_TYPE_BASIC = "BASIC" def __init__(self, **kwargs): """ Initializes a new Forecast object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): - :param forcast_type: - The value to assign to the forcast_type property of this Forecast. - Allowed values for this property are: "BASIC" - :type forcast_type: str + :param forecast_type: + The value to assign to the forecast_type property of this Forecast. + Allowed values for this property are: "BASIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type forecast_type: str :param time_forecast_started: The value to assign to the time_forecast_started property of this Forecast. @@ -37,58 +38,56 @@ def __init__(self, **kwargs): """ self.swagger_types = { - 'forcast_type': 'str', + 'forecast_type': 'str', 'time_forecast_started': 'datetime', 'time_forecast_ended': 'datetime' } self.attribute_map = { - 'forcast_type': 'forcastType', + 'forecast_type': 'forecastType', 'time_forecast_started': 'timeForecastStarted', 'time_forecast_ended': 'timeForecastEnded' } - self._forcast_type = None + self._forecast_type = None self._time_forecast_started = None self._time_forecast_ended = None @property - def forcast_type(self): + def forecast_type(self): """ - Gets the forcast_type of this Forecast. + Gets the forecast_type of this Forecast. BASIC uses ETS to project future usage/cost based on history data. The basis for projections will be a rolling set of equivalent historical days for which projection is being made. - Allowed values for this property are: "BASIC" + Allowed values for this property are: "BASIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :return: The forcast_type of this Forecast. + :return: The forecast_type of this Forecast. :rtype: str """ - return self._forcast_type + return self._forecast_type - @forcast_type.setter - def forcast_type(self, forcast_type): + @forecast_type.setter + def forecast_type(self, forecast_type): """ - Sets the forcast_type of this Forecast. + Sets the forecast_type of this Forecast. BASIC uses ETS to project future usage/cost based on history data. The basis for projections will be a rolling set of equivalent historical days for which projection is being made. - :param forcast_type: The forcast_type of this Forecast. + :param forecast_type: The forecast_type of this Forecast. :type: str """ allowed_values = ["BASIC"] - if not value_allowed_none_or_none_sentinel(forcast_type, allowed_values): - raise ValueError( - "Invalid value for `forcast_type`, must be None or one of {0}" - .format(allowed_values) - ) - self._forcast_type = forcast_type + if not value_allowed_none_or_none_sentinel(forecast_type, allowed_values): + forecast_type = 'UNKNOWN_ENUM_VALUE' + self._forecast_type = forecast_type @property def time_forecast_started(self): """ - **[Required]** Gets the time_forecast_started of this Forecast. - forecast start time. + Gets the time_forecast_started of this Forecast. + forecast start time. Will default to UTC-1 if not specified :return: The time_forecast_started of this Forecast. @@ -100,7 +99,7 @@ def time_forecast_started(self): def time_forecast_started(self, time_forecast_started): """ Sets the time_forecast_started of this Forecast. - forecast start time. + forecast start time. Will default to UTC-1 if not specified :param time_forecast_started: The time_forecast_started of this Forecast. diff --git a/src/oci/usage_api/models/report_query.py b/src/oci/usage_api/models/report_query.py index 5fc12bedf5..fac5c85b61 100644 --- a/src/oci/usage_api/models/report_query.py +++ b/src/oci/usage_api/models/report_query.py @@ -104,6 +104,10 @@ def __init__(self, **kwargs): The value to assign to the is_aggregate_by_time property of this ReportQuery. :type is_aggregate_by_time: bool + :param forecast: + The value to assign to the forecast property of this ReportQuery. + :type forecast: oci.usage_api.models.Forecast + :param query_type: The value to assign to the query_type property of this ReportQuery. Allowed values for this property are: "USAGE", "COST", 'UNKNOWN_ENUM_VALUE'. @@ -139,6 +143,7 @@ def __init__(self, **kwargs): 'time_usage_ended': 'datetime', 'granularity': 'str', 'is_aggregate_by_time': 'bool', + 'forecast': 'Forecast', 'query_type': 'str', 'group_by': 'list[str]', 'group_by_tag': 'list[Tag]', @@ -153,6 +158,7 @@ def __init__(self, **kwargs): 'time_usage_ended': 'timeUsageEnded', 'granularity': 'granularity', 'is_aggregate_by_time': 'isAggregateByTime', + 'forecast': 'forecast', 'query_type': 'queryType', 'group_by': 'groupBy', 'group_by_tag': 'groupByTag', @@ -166,6 +172,7 @@ def __init__(self, **kwargs): self._time_usage_ended = None self._granularity = None self._is_aggregate_by_time = None + self._forecast = None self._query_type = None self._group_by = None self._group_by_tag = None @@ -307,6 +314,26 @@ def is_aggregate_by_time(self, is_aggregate_by_time): """ self._is_aggregate_by_time = is_aggregate_by_time + @property + def forecast(self): + """ + Gets the forecast of this ReportQuery. + + :return: The forecast of this ReportQuery. + :rtype: oci.usage_api.models.Forecast + """ + return self._forecast + + @forecast.setter + def forecast(self, forecast): + """ + Sets the forecast of this ReportQuery. + + :param forecast: The forecast of this ReportQuery. + :type: oci.usage_api.models.Forecast + """ + self._forecast = forecast + @property def query_type(self): """ @@ -377,8 +404,8 @@ def group_by(self, group_by): def group_by_tag(self): """ Gets the group_by_tag of this ReportQuery. - GroupBy a specific tagKey. Provide tagNamespace and tagKey in tag object. Only support one tag in the list - example: + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]` @@ -391,8 +418,8 @@ def group_by_tag(self): def group_by_tag(self, group_by_tag): """ Sets the group_by_tag of this ReportQuery. - GroupBy a specific tagKey. Provide tagNamespace and tagKey in tag object. Only support one tag in the list - example: + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]` diff --git a/src/oci/usage_api/models/request_summarized_usages_details.py b/src/oci/usage_api/models/request_summarized_usages_details.py index b79f4e2367..193a98ae12 100644 --- a/src/oci/usage_api/models/request_summarized_usages_details.py +++ b/src/oci/usage_api/models/request_summarized_usages_details.py @@ -63,6 +63,10 @@ def __init__(self, **kwargs): The value to assign to the is_aggregate_by_time property of this RequestSummarizedUsagesDetails. :type is_aggregate_by_time: bool + :param forecast: + The value to assign to the forecast property of this RequestSummarizedUsagesDetails. + :type forecast: oci.usage_api.models.Forecast + :param query_type: The value to assign to the query_type property of this RequestSummarizedUsagesDetails. Allowed values for this property are: "USAGE", "COST" @@ -91,6 +95,7 @@ def __init__(self, **kwargs): 'time_usage_ended': 'datetime', 'granularity': 'str', 'is_aggregate_by_time': 'bool', + 'forecast': 'Forecast', 'query_type': 'str', 'group_by': 'list[str]', 'group_by_tag': 'list[Tag]', @@ -104,6 +109,7 @@ def __init__(self, **kwargs): 'time_usage_ended': 'timeUsageEnded', 'granularity': 'granularity', 'is_aggregate_by_time': 'isAggregateByTime', + 'forecast': 'forecast', 'query_type': 'queryType', 'group_by': 'groupBy', 'group_by_tag': 'groupByTag', @@ -116,6 +122,7 @@ def __init__(self, **kwargs): self._time_usage_ended = None self._granularity = None self._is_aggregate_by_time = None + self._forecast = None self._query_type = None self._group_by = None self._group_by_tag = None @@ -126,7 +133,7 @@ def __init__(self, **kwargs): def tenant_id(self): """ **[Required]** Gets the tenant_id of this RequestSummarizedUsagesDetails. - Tenant ID + Tenant ID. :return: The tenant_id of this RequestSummarizedUsagesDetails. @@ -138,7 +145,7 @@ def tenant_id(self): def tenant_id(self, tenant_id): """ Sets the tenant_id of this RequestSummarizedUsagesDetails. - Tenant ID + Tenant ID. :param tenant_id: The tenant_id of this RequestSummarizedUsagesDetails. @@ -258,6 +265,26 @@ def is_aggregate_by_time(self, is_aggregate_by_time): """ self._is_aggregate_by_time = is_aggregate_by_time + @property + def forecast(self): + """ + Gets the forecast of this RequestSummarizedUsagesDetails. + + :return: The forecast of this RequestSummarizedUsagesDetails. + :rtype: oci.usage_api.models.Forecast + """ + return self._forecast + + @forecast.setter + def forecast(self, forecast): + """ + Sets the forecast of this RequestSummarizedUsagesDetails. + + :param forecast: The forecast of this RequestSummarizedUsagesDetails. + :type: oci.usage_api.models.Forecast + """ + self._forecast = forecast + @property def query_type(self): """ diff --git a/src/oci/usage_api/models/usage_summary.py b/src/oci/usage_api/models/usage_summary.py index 6b2333861d..aad8bd6249 100644 --- a/src/oci/usage_api/models/usage_summary.py +++ b/src/oci/usage_api/models/usage_summary.py @@ -126,6 +126,10 @@ def __init__(self, **kwargs): The value to assign to the overage property of this UsageSummary. :type overage: str + :param is_forecast: + The value to assign to the is_forecast property of this UsageSummary. + :type is_forecast: bool + :param tags: The value to assign to the tags property of this UsageSummary. :type tags: list[oci.usage_api.models.Tag] @@ -159,6 +163,7 @@ def __init__(self, **kwargs): 'currency': 'str', 'subscription_id': 'str', 'overage': 'str', + 'is_forecast': 'bool', 'tags': 'list[Tag]' } @@ -190,6 +195,7 @@ def __init__(self, **kwargs): 'currency': 'currency', 'subscription_id': 'subscriptionId', 'overage': 'overage', + 'is_forecast': 'isForecast', 'tags': 'tags' } @@ -220,6 +226,7 @@ def __init__(self, **kwargs): self._currency = None self._subscription_id = None self._overage = None + self._is_forecast = None self._tags = None @property @@ -870,6 +877,30 @@ def overage(self, overage): """ self._overage = overage + @property + def is_forecast(self): + """ + Gets the is_forecast of this UsageSummary. + is forecasted data + + + :return: The is_forecast of this UsageSummary. + :rtype: bool + """ + return self._is_forecast + + @is_forecast.setter + def is_forecast(self, is_forecast): + """ + Sets the is_forecast of this UsageSummary. + is forecasted data + + + :param is_forecast: The is_forecast of this UsageSummary. + :type: bool + """ + self._is_forecast = is_forecast + @property def tags(self): """ diff --git a/src/oci/util.py b/src/oci/util.py index c54a327223..345d2144e9 100644 --- a/src/oci/util.py +++ b/src/oci/util.py @@ -10,6 +10,10 @@ from oci._vendor import six import os from oci.exceptions import InvalidConfig +try: + from urllib.parse import urlparse +except ImportError: + from urlparse import urlparse INSTANCE_PRINCIPAL_AUTHENTICATION_TYPE_VALUE_NAME = 'instance_principal' DELEGATION_TOKEN_WITH_INSTANCE_PRINCIPAL_AUTHENTICATION_TYPE = 'delegation_token_with_instance_principal' @@ -195,3 +199,17 @@ def get_authentication_type_from_config(config): raise InvalidConfig("The authentication type {} requires config values for the keys {}".format(DELEGATION_TOKEN_WITH_INSTANCE_PRINCIPAL_AUTHENTICATION_TYPE, DELEGATION_TOKEN_FILE_FIELD_NAME)) else: raise InvalidConfig("The authentication type {} is not supported".format(auth_type)) + + +def extract_service_endpoint(endpoint_with_base_path): + """ + Takes a Service Endpoint with base-path embedded and extracts the Service Endpoint from it. + + :param str endpoint_with_base_path: + Service Endpoint with base-path embedded + + :return: The Service Endpoint without base-path. + :rtype: str + """ + parsed_endpoint = urlparse(endpoint_with_base_path) + return parsed_endpoint.scheme + r'://' + parsed_endpoint.netloc diff --git a/src/oci/version.py b/src/oci/version.py index f364699501..c28d805768 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -__version__ = "2.34.0" +__version__ = "2.35.0" diff --git a/src/oci/vulnerability_scanning/__init__.py b/src/oci/vulnerability_scanning/__init__.py new file mode 100644 index 0000000000..7b33f56ecf --- /dev/null +++ b/src/oci/vulnerability_scanning/__init__.py @@ -0,0 +1,12 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .vulnerability_scanning_client import VulnerabilityScanningClient +from .vulnerability_scanning_client_composite_operations import VulnerabilityScanningClientCompositeOperations +from . import models + +__all__ = ["VulnerabilityScanningClient", "VulnerabilityScanningClientCompositeOperations", "models"] diff --git a/src/oci/vulnerability_scanning/models/__init__.py b/src/oci/vulnerability_scanning/models/__init__.py new file mode 100644 index 0000000000..0991acf57d --- /dev/null +++ b/src/oci/vulnerability_scanning/models/__init__.py @@ -0,0 +1,166 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .change_container_scan_recipe_compartment_details import ChangeContainerScanRecipeCompartmentDetails +from .change_container_scan_result_compartment_details import ChangeContainerScanResultCompartmentDetails +from .change_container_scan_target_compartment_details import ChangeContainerScanTargetCompartmentDetails +from .change_host_agent_scan_result_compartment_details import ChangeHostAgentScanResultCompartmentDetails +from .change_host_cis_benchmark_scan_result_compartment_details import ChangeHostCisBenchmarkScanResultCompartmentDetails +from .change_host_endpoint_protection_scan_result_compartment_details import ChangeHostEndpointProtectionScanResultCompartmentDetails +from .change_host_port_scan_result_compartment_details import ChangeHostPortScanResultCompartmentDetails +from .change_host_scan_recipe_compartment_details import ChangeHostScanRecipeCompartmentDetails +from .change_host_scan_target_compartment_details import ChangeHostScanTargetCompartmentDetails +from .container_scan_recipe import ContainerScanRecipe +from .container_scan_recipe_summary import ContainerScanRecipeSummary +from .container_scan_recipe_summary_collection import ContainerScanRecipeSummaryCollection +from .container_scan_registry import ContainerScanRegistry +from .container_scan_result import ContainerScanResult +from .container_scan_result_problem import ContainerScanResultProblem +from .container_scan_result_summary import ContainerScanResultSummary +from .container_scan_result_summary_collection import ContainerScanResultSummaryCollection +from .container_scan_settings import ContainerScanSettings +from .container_scan_target import ContainerScanTarget +from .container_scan_target_summary import ContainerScanTargetSummary +from .container_scan_target_summary_collection import ContainerScanTargetSummaryCollection +from .create_container_scan_recipe_details import CreateContainerScanRecipeDetails +from .create_container_scan_registry_details import CreateContainerScanRegistryDetails +from .create_container_scan_target_details import CreateContainerScanTargetDetails +from .create_host_scan_recipe_details import CreateHostScanRecipeDetails +from .create_host_scan_target_details import CreateHostScanTargetDetails +from .create_ocir_container_scan_registry_details import CreateOcirContainerScanRegistryDetails +from .cve_details import CveDetails +from .export_host_agent_scan_result_csv_details import ExportHostAgentScanResultCsvDetails +from .export_host_vulnerability_csv_details import ExportHostVulnerabilityCsvDetails +from .host_agent_scan_result import HostAgentScanResult +from .host_agent_scan_result_problem import HostAgentScanResultProblem +from .host_agent_scan_result_summary import HostAgentScanResultSummary +from .host_agent_scan_result_summary_collection import HostAgentScanResultSummaryCollection +from .host_cis_benchmark_scan_result import HostCisBenchmarkScanResult +from .host_cis_benchmark_scan_result_score import HostCisBenchmarkScanResultScore +from .host_cis_benchmark_scan_result_summary import HostCisBenchmarkScanResultSummary +from .host_cis_benchmark_scan_result_summary_collection import HostCisBenchmarkScanResultSummaryCollection +from .host_cis_benchmark_settings import HostCisBenchmarkSettings +from .host_endpoint_protection_scan_result import HostEndpointProtectionScanResult +from .host_endpoint_protection_scan_result_endpoint_protection import HostEndpointProtectionScanResultEndpointProtection +from .host_endpoint_protection_scan_result_summary import HostEndpointProtectionScanResultSummary +from .host_endpoint_protection_scan_result_summary_collection import HostEndpointProtectionScanResultSummaryCollection +from .host_endpoint_protection_settings import HostEndpointProtectionSettings +from .host_port_scan_result import HostPortScanResult +from .host_port_scan_result_open_port import HostPortScanResultOpenPort +from .host_port_scan_result_summary import HostPortScanResultSummary +from .host_port_scan_result_summary_collection import HostPortScanResultSummaryCollection +from .host_scan_agent_configuration import HostScanAgentConfiguration +from .host_scan_agent_configuration_oci import HostScanAgentConfigurationOCI +from .host_scan_agent_settings import HostScanAgentSettings +from .host_scan_port_settings import HostScanPortSettings +from .host_scan_recipe import HostScanRecipe +from .host_scan_recipe_summary import HostScanRecipeSummary +from .host_scan_recipe_summary_collection import HostScanRecipeSummaryCollection +from .host_scan_target import HostScanTarget +from .host_scan_target_summary import HostScanTargetSummary +from .host_scan_target_summary_collection import HostScanTargetSummaryCollection +from .host_vulnerability import HostVulnerability +from .host_vulnerability_impacted_host_summary import HostVulnerabilityImpactedHostSummary +from .host_vulnerability_impacted_host_summary_collection import HostVulnerabilityImpactedHostSummaryCollection +from .host_vulnerability_summary import HostVulnerabilitySummary +from .host_vulnerability_summary_collection import HostVulnerabilitySummaryCollection +from .ocir_container_scan_registry import OcirContainerScanRegistry +from .schedule import Schedule +from .update_container_scan_recipe_details import UpdateContainerScanRecipeDetails +from .update_container_scan_registry_details import UpdateContainerScanRegistryDetails +from .update_container_scan_target_details import UpdateContainerScanTargetDetails +from .update_host_scan_recipe_details import UpdateHostScanRecipeDetails +from .update_host_scan_target_details import UpdateHostScanTargetDetails +from .update_ocir_container_scan_registry_details import UpdateOcirContainerScanRegistryDetails +from .work_request import WorkRequest +from .work_request_collection import WorkRequestCollection +from .work_request_error import WorkRequestError +from .work_request_error_collection import WorkRequestErrorCollection +from .work_request_log_entry import WorkRequestLogEntry +from .work_request_log_entry_collection import WorkRequestLogEntryCollection +from .work_request_resource import WorkRequestResource + +# Maps type names to classes for vulnerability_scanning services. +vulnerability_scanning_type_mapping = { + "ChangeContainerScanRecipeCompartmentDetails": ChangeContainerScanRecipeCompartmentDetails, + "ChangeContainerScanResultCompartmentDetails": ChangeContainerScanResultCompartmentDetails, + "ChangeContainerScanTargetCompartmentDetails": ChangeContainerScanTargetCompartmentDetails, + "ChangeHostAgentScanResultCompartmentDetails": ChangeHostAgentScanResultCompartmentDetails, + "ChangeHostCisBenchmarkScanResultCompartmentDetails": ChangeHostCisBenchmarkScanResultCompartmentDetails, + "ChangeHostEndpointProtectionScanResultCompartmentDetails": ChangeHostEndpointProtectionScanResultCompartmentDetails, + "ChangeHostPortScanResultCompartmentDetails": ChangeHostPortScanResultCompartmentDetails, + "ChangeHostScanRecipeCompartmentDetails": ChangeHostScanRecipeCompartmentDetails, + "ChangeHostScanTargetCompartmentDetails": ChangeHostScanTargetCompartmentDetails, + "ContainerScanRecipe": ContainerScanRecipe, + "ContainerScanRecipeSummary": ContainerScanRecipeSummary, + "ContainerScanRecipeSummaryCollection": ContainerScanRecipeSummaryCollection, + "ContainerScanRegistry": ContainerScanRegistry, + "ContainerScanResult": ContainerScanResult, + "ContainerScanResultProblem": ContainerScanResultProblem, + "ContainerScanResultSummary": ContainerScanResultSummary, + "ContainerScanResultSummaryCollection": ContainerScanResultSummaryCollection, + "ContainerScanSettings": ContainerScanSettings, + "ContainerScanTarget": ContainerScanTarget, + "ContainerScanTargetSummary": ContainerScanTargetSummary, + "ContainerScanTargetSummaryCollection": ContainerScanTargetSummaryCollection, + "CreateContainerScanRecipeDetails": CreateContainerScanRecipeDetails, + "CreateContainerScanRegistryDetails": CreateContainerScanRegistryDetails, + "CreateContainerScanTargetDetails": CreateContainerScanTargetDetails, + "CreateHostScanRecipeDetails": CreateHostScanRecipeDetails, + "CreateHostScanTargetDetails": CreateHostScanTargetDetails, + "CreateOcirContainerScanRegistryDetails": CreateOcirContainerScanRegistryDetails, + "CveDetails": CveDetails, + "ExportHostAgentScanResultCsvDetails": ExportHostAgentScanResultCsvDetails, + "ExportHostVulnerabilityCsvDetails": ExportHostVulnerabilityCsvDetails, + "HostAgentScanResult": HostAgentScanResult, + "HostAgentScanResultProblem": HostAgentScanResultProblem, + "HostAgentScanResultSummary": HostAgentScanResultSummary, + "HostAgentScanResultSummaryCollection": HostAgentScanResultSummaryCollection, + "HostCisBenchmarkScanResult": HostCisBenchmarkScanResult, + "HostCisBenchmarkScanResultScore": HostCisBenchmarkScanResultScore, + "HostCisBenchmarkScanResultSummary": HostCisBenchmarkScanResultSummary, + "HostCisBenchmarkScanResultSummaryCollection": HostCisBenchmarkScanResultSummaryCollection, + "HostCisBenchmarkSettings": HostCisBenchmarkSettings, + "HostEndpointProtectionScanResult": HostEndpointProtectionScanResult, + "HostEndpointProtectionScanResultEndpointProtection": HostEndpointProtectionScanResultEndpointProtection, + "HostEndpointProtectionScanResultSummary": HostEndpointProtectionScanResultSummary, + "HostEndpointProtectionScanResultSummaryCollection": HostEndpointProtectionScanResultSummaryCollection, + "HostEndpointProtectionSettings": HostEndpointProtectionSettings, + "HostPortScanResult": HostPortScanResult, + "HostPortScanResultOpenPort": HostPortScanResultOpenPort, + "HostPortScanResultSummary": HostPortScanResultSummary, + "HostPortScanResultSummaryCollection": HostPortScanResultSummaryCollection, + "HostScanAgentConfiguration": HostScanAgentConfiguration, + "HostScanAgentConfigurationOCI": HostScanAgentConfigurationOCI, + "HostScanAgentSettings": HostScanAgentSettings, + "HostScanPortSettings": HostScanPortSettings, + "HostScanRecipe": HostScanRecipe, + "HostScanRecipeSummary": HostScanRecipeSummary, + "HostScanRecipeSummaryCollection": HostScanRecipeSummaryCollection, + "HostScanTarget": HostScanTarget, + "HostScanTargetSummary": HostScanTargetSummary, + "HostScanTargetSummaryCollection": HostScanTargetSummaryCollection, + "HostVulnerability": HostVulnerability, + "HostVulnerabilityImpactedHostSummary": HostVulnerabilityImpactedHostSummary, + "HostVulnerabilityImpactedHostSummaryCollection": HostVulnerabilityImpactedHostSummaryCollection, + "HostVulnerabilitySummary": HostVulnerabilitySummary, + "HostVulnerabilitySummaryCollection": HostVulnerabilitySummaryCollection, + "OcirContainerScanRegistry": OcirContainerScanRegistry, + "Schedule": Schedule, + "UpdateContainerScanRecipeDetails": UpdateContainerScanRecipeDetails, + "UpdateContainerScanRegistryDetails": UpdateContainerScanRegistryDetails, + "UpdateContainerScanTargetDetails": UpdateContainerScanTargetDetails, + "UpdateHostScanRecipeDetails": UpdateHostScanRecipeDetails, + "UpdateHostScanTargetDetails": UpdateHostScanTargetDetails, + "UpdateOcirContainerScanRegistryDetails": UpdateOcirContainerScanRegistryDetails, + "WorkRequest": WorkRequest, + "WorkRequestCollection": WorkRequestCollection, + "WorkRequestError": WorkRequestError, + "WorkRequestErrorCollection": WorkRequestErrorCollection, + "WorkRequestLogEntry": WorkRequestLogEntry, + "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection, + "WorkRequestResource": WorkRequestResource +} diff --git a/src/oci/vulnerability_scanning/models/change_container_scan_recipe_compartment_details.py b/src/oci/vulnerability_scanning/models/change_container_scan_recipe_compartment_details.py new file mode 100644 index 0000000000..7decc63e3a --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_container_scan_recipe_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeContainerScanRecipeCompartmentDetails(object): + """ + Details for a ContainerScanRecipe compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeContainerScanRecipeCompartmentDetails 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 ChangeContainerScanRecipeCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeContainerScanRecipeCompartmentDetails. + The `OCID`__ of the compartment into which the container scan recipe should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeContainerScanRecipeCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeContainerScanRecipeCompartmentDetails. + The `OCID`__ of the compartment into which the container scan recipe should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeContainerScanRecipeCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_container_scan_result_compartment_details.py b/src/oci/vulnerability_scanning/models/change_container_scan_result_compartment_details.py new file mode 100644 index 0000000000..f6f0852a5a --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_container_scan_result_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeContainerScanResultCompartmentDetails(object): + """ + Details for a ContainerScanResult compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeContainerScanResultCompartmentDetails 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 ChangeContainerScanResultCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeContainerScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the container scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeContainerScanResultCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeContainerScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the container scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeContainerScanResultCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_container_scan_target_compartment_details.py b/src/oci/vulnerability_scanning/models/change_container_scan_target_compartment_details.py new file mode 100644 index 0000000000..9de5e068aa --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_container_scan_target_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeContainerScanTargetCompartmentDetails(object): + """ + Details for a ContainerScanTarget compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeContainerScanTargetCompartmentDetails 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 ChangeContainerScanTargetCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeContainerScanTargetCompartmentDetails. + The `OCID`__ of the compartment into which the container scan target should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeContainerScanTargetCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeContainerScanTargetCompartmentDetails. + The `OCID`__ of the compartment into which the container scan target should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeContainerScanTargetCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_agent_scan_result_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_agent_scan_result_compartment_details.py new file mode 100644 index 0000000000..cb737f56a6 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_agent_scan_result_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostAgentScanResultCompartmentDetails(object): + """ + Details for a HostAgentScanResult compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostAgentScanResultCompartmentDetails 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 ChangeHostAgentScanResultCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostAgentScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host agent scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostAgentScanResultCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostAgentScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host agent scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostAgentScanResultCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_cis_benchmark_scan_result_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_cis_benchmark_scan_result_compartment_details.py new file mode 100644 index 0000000000..b349deac94 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_cis_benchmark_scan_result_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostCisBenchmarkScanResultCompartmentDetails(object): + """ + Details for a HostCisBenchmarkScanResult compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostCisBenchmarkScanResultCompartmentDetails 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 ChangeHostCisBenchmarkScanResultCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostCisBenchmarkScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostCisBenchmarkScanResultCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostCisBenchmarkScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostCisBenchmarkScanResultCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_endpoint_protection_scan_result_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_endpoint_protection_scan_result_compartment_details.py new file mode 100644 index 0000000000..979f230667 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_endpoint_protection_scan_result_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostEndpointProtectionScanResultCompartmentDetails(object): + """ + Details for a HostEndpointProtectionScanResult compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostEndpointProtectionScanResultCompartmentDetails 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 ChangeHostEndpointProtectionScanResultCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostEndpointProtectionScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostEndpointProtectionScanResultCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostEndpointProtectionScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostEndpointProtectionScanResultCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_port_scan_result_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_port_scan_result_compartment_details.py new file mode 100644 index 0000000000..a46c286c1b --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_port_scan_result_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostPortScanResultCompartmentDetails(object): + """ + Details for a HostPortScanResult compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostPortScanResultCompartmentDetails 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 ChangeHostPortScanResultCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostPortScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostPortScanResultCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostPortScanResultCompartmentDetails. + The `OCID`__ of the compartment into which the host port scan should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostPortScanResultCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_scan_recipe_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_scan_recipe_compartment_details.py new file mode 100644 index 0000000000..3a970e932c --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_scan_recipe_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostScanRecipeCompartmentDetails(object): + """ + Details for a HostScanRecipe compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostScanRecipeCompartmentDetails 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 ChangeHostScanRecipeCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostScanRecipeCompartmentDetails. + The `OCID`__ of the compartment into which the host scan recipe should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostScanRecipeCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostScanRecipeCompartmentDetails. + The `OCID`__ of the compartment into which the host scan recipe should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostScanRecipeCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/change_host_scan_target_compartment_details.py b/src/oci/vulnerability_scanning/models/change_host_scan_target_compartment_details.py new file mode 100644 index 0000000000..1eab431550 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/change_host_scan_target_compartment_details.py @@ -0,0 +1,74 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeHostScanTargetCompartmentDetails(object): + """ + Details for a HostScanTarget compartment change + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeHostScanTargetCompartmentDetails 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 ChangeHostScanTargetCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangeHostScanTargetCompartmentDetails. + The `OCID`__ of the compartment into which the host scan target should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeHostScanTargetCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeHostScanTargetCompartmentDetails. + The `OCID`__ of the compartment into which the host scan target should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeHostScanTargetCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_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/vulnerability_scanning/models/container_scan_recipe.py b/src/oci/vulnerability_scanning/models/container_scan_recipe.py new file mode 100644 index 0000000000..b2747db64b --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_recipe.py @@ -0,0 +1,399 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanRecipe(object): + """ + A container scan recipe (collection of container scanning configuration settings) + """ + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanRecipe 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 ContainerScanRecipe. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ContainerScanRecipe. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanRecipe. + :type compartment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ContainerScanRecipe. + 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 time_created: + The value to assign to the time_created property of this ContainerScanRecipe. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ContainerScanRecipe. + :type time_updated: datetime + + :param scan_settings: + The value to assign to the scan_settings property of this ContainerScanRecipe. + :type scan_settings: oci.vulnerability_scanning.models.ContainerScanSettings + + :param freeform_tags: + The value to assign to the freeform_tags property of this ContainerScanRecipe. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ContainerScanRecipe. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ContainerScanRecipe. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'scan_settings': 'ContainerScanSettings', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'scan_settings': 'scanSettings', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._scan_settings = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanRecipe. + The `OCID`__ of container scan recipe. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanRecipe. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanRecipe. + The `OCID`__ of container scan recipe. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanRecipe. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ContainerScanRecipe. + User friendly name of container scan recipe + + + :return: The display_name of this ContainerScanRecipe. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContainerScanRecipe. + User friendly name of container scan recipe + + + :param display_name: The display_name of this ContainerScanRecipe. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanRecipe. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanRecipe. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanRecipe. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanRecipe. + :type: str + """ + self._compartment_id = compartment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ContainerScanRecipe. + The current state of the config. + + 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 ContainerScanRecipe. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ContainerScanRecipe. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this ContainerScanRecipe. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this ContainerScanRecipe. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this ContainerScanRecipe. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ContainerScanRecipe. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this ContainerScanRecipe. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this ContainerScanRecipe. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this ContainerScanRecipe. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ContainerScanRecipe. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this ContainerScanRecipe. + :type: datetime + """ + self._time_updated = time_updated + + @property + def scan_settings(self): + """ + **[Required]** Gets the scan_settings of this ContainerScanRecipe. + + :return: The scan_settings of this ContainerScanRecipe. + :rtype: oci.vulnerability_scanning.models.ContainerScanSettings + """ + return self._scan_settings + + @scan_settings.setter + def scan_settings(self, scan_settings): + """ + Sets the scan_settings of this ContainerScanRecipe. + + :param scan_settings: The scan_settings of this ContainerScanRecipe. + :type: oci.vulnerability_scanning.models.ContainerScanSettings + """ + self._scan_settings = scan_settings + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ContainerScanRecipe. + 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 ContainerScanRecipe. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ContainerScanRecipe. + 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 ContainerScanRecipe. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ContainerScanRecipe. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ContainerScanRecipe. + :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 ContainerScanRecipe. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ContainerScanRecipe. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ContainerScanRecipe. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this ContainerScanRecipe. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this ContainerScanRecipe. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this ContainerScanRecipe. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/container_scan_recipe_summary.py b/src/oci/vulnerability_scanning/models/container_scan_recipe_summary.py new file mode 100644 index 0000000000..5ee4d23d2d --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_recipe_summary.py @@ -0,0 +1,372 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanRecipeSummary(object): + """ + Summary of a container scan recipe (collection of container scanning configuration settings) + """ + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanRecipeSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanRecipeSummary 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 ContainerScanRecipeSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ContainerScanRecipeSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanRecipeSummary. + :type compartment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ContainerScanRecipeSummary. + 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 time_created: + The value to assign to the time_created property of this ContainerScanRecipeSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ContainerScanRecipeSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this ContainerScanRecipeSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ContainerScanRecipeSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ContainerScanRecipeSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanRecipeSummary. + The `OCID`__ of container scan recipe. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanRecipeSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanRecipeSummary. + The `OCID`__ of container scan recipe. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanRecipeSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ContainerScanRecipeSummary. + User friendly name of container scan recipe + + + :return: The display_name of this ContainerScanRecipeSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContainerScanRecipeSummary. + User friendly name of container scan recipe + + + :param display_name: The display_name of this ContainerScanRecipeSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanRecipeSummary. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanRecipeSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanRecipeSummary. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanRecipeSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ContainerScanRecipeSummary. + The current state of the config. + + 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 ContainerScanRecipeSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ContainerScanRecipeSummary. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this ContainerScanRecipeSummary. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this ContainerScanRecipeSummary. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this ContainerScanRecipeSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ContainerScanRecipeSummary. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this ContainerScanRecipeSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this ContainerScanRecipeSummary. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this ContainerScanRecipeSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ContainerScanRecipeSummary. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this ContainerScanRecipeSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ContainerScanRecipeSummary. + 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 ContainerScanRecipeSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ContainerScanRecipeSummary. + 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 ContainerScanRecipeSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ContainerScanRecipeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ContainerScanRecipeSummary. + :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 ContainerScanRecipeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ContainerScanRecipeSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ContainerScanRecipeSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this ContainerScanRecipeSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this ContainerScanRecipeSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this ContainerScanRecipeSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/container_scan_recipe_summary_collection.py b/src/oci/vulnerability_scanning/models/container_scan_recipe_summary_collection.py new file mode 100644 index 0000000000..3a5d48fc4b --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_recipe_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanRecipeSummaryCollection(object): + """ + A collection of ContainerScanRecipeSummary objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanRecipeSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this ContainerScanRecipeSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.ContainerScanRecipeSummary] + + """ + self.swagger_types = { + 'items': 'list[ContainerScanRecipeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ContainerScanRecipeSummaryCollection. + The ContainerScanRecipeSummary objects in the collection + + + :return: The items of this ContainerScanRecipeSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.ContainerScanRecipeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ContainerScanRecipeSummaryCollection. + The ContainerScanRecipeSummary objects in the collection + + + :param items: The items of this ContainerScanRecipeSummaryCollection. + :type: list[oci.vulnerability_scanning.models.ContainerScanRecipeSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/container_scan_registry.py b/src/oci/vulnerability_scanning/models/container_scan_registry.py new file mode 100644 index 0000000000..cf9308cb8c --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_registry.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanRegistry(object): + """ + Registry information for a container scan target + """ + + #: A constant which can be used with the type property of a ContainerScanRegistry. + #: This constant has a value of "OCIR" + TYPE_OCIR = "OCIR" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanRegistry 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.vulnerability_scanning.models.OcirContainerScanRegistry` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this ContainerScanRegistry. + Allowed values for this property are: "OCIR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param url: + The value to assign to the url property of this ContainerScanRegistry. + :type url: str + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url' + } + + self._type = None + self._url = 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['type'] + + if type == 'OCIR': + return 'OcirContainerScanRegistry' + else: + return 'ContainerScanRegistry' + + @property + def type(self): + """ + **[Required]** Gets the type of this ContainerScanRegistry. + The scan level + + Allowed values for this property are: "OCIR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this ContainerScanRegistry. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ContainerScanRegistry. + The scan level + + + :param type: The type of this ContainerScanRegistry. + :type: str + """ + allowed_values = ["OCIR"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def url(self): + """ + **[Required]** Gets the url of this ContainerScanRegistry. + URL of the registry. + + + :return: The url of this ContainerScanRegistry. + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """ + Sets the url of this ContainerScanRegistry. + URL of the registry. + + + :param url: The url of this ContainerScanRegistry. + :type: str + """ + self._url = url + + 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/vulnerability_scanning/models/container_scan_result.py b/src/oci/vulnerability_scanning/models/container_scan_result.py new file mode 100644 index 0000000000..dc021c68f8 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_result.py @@ -0,0 +1,393 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanResult(object): + """ + A scan result for a container scan + """ + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResult. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResult. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResult. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResult. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResult. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanResult 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 ContainerScanResult. + :type id: str + + :param registry_url: + The value to assign to the registry_url property of this ContainerScanResult. + :type registry_url: str + + :param repository: + The value to assign to the repository property of this ContainerScanResult. + :type repository: str + + :param image: + The value to assign to the image property of this ContainerScanResult. + :type image: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanResult. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this ContainerScanResult. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param problem_count: + The value to assign to the problem_count property of this ContainerScanResult. + :type problem_count: int + + :param time_started: + The value to assign to the time_started property of this ContainerScanResult. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this ContainerScanResult. + :type time_finished: datetime + + :param problems: + The value to assign to the problems property of this ContainerScanResult. + :type problems: list[oci.vulnerability_scanning.models.ContainerScanResultProblem] + + """ + self.swagger_types = { + 'id': 'str', + 'registry_url': 'str', + 'repository': 'str', + 'image': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'problem_count': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'problems': 'list[ContainerScanResultProblem]' + } + + self.attribute_map = { + 'id': 'id', + 'registry_url': 'registryUrl', + 'repository': 'repository', + 'image': 'image', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'problem_count': 'problemCount', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'problems': 'problems' + } + + self._id = None + self._registry_url = None + self._repository = None + self._image = None + self._compartment_id = None + self._highest_problem_severity = None + self._problem_count = None + self._time_started = None + self._time_finished = None + self._problems = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanResult. + The `OCID`__ of container scan result. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanResult. + The `OCID`__ of container scan result. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanResult. + :type: str + """ + self._id = id + + @property + def registry_url(self): + """ + Gets the registry_url of this ContainerScanResult. + The URL of the docker registry the repository is located in. + + + :return: The registry_url of this ContainerScanResult. + :rtype: str + """ + return self._registry_url + + @registry_url.setter + def registry_url(self, registry_url): + """ + Sets the registry_url of this ContainerScanResult. + The URL of the docker registry the repository is located in. + + + :param registry_url: The registry_url of this ContainerScanResult. + :type: str + """ + self._registry_url = registry_url + + @property + def repository(self): + """ + **[Required]** Gets the repository of this ContainerScanResult. + Repository in which the container image scanned is located + + + :return: The repository of this ContainerScanResult. + :rtype: str + """ + return self._repository + + @repository.setter + def repository(self, repository): + """ + Sets the repository of this ContainerScanResult. + Repository in which the container image scanned is located + + + :param repository: The repository of this ContainerScanResult. + :type: str + """ + self._repository = repository + + @property + def image(self): + """ + **[Required]** Gets the image of this ContainerScanResult. + Image name + + + :return: The image of this ContainerScanResult. + :rtype: str + """ + return self._image + + @image.setter + def image(self, image): + """ + Sets the image of this ContainerScanResult. + Image name + + + :param image: The image of this ContainerScanResult. + :type: str + """ + self._image = image + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanResult. + The `OCID`__ of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanResult. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanResult. + The `OCID`__ of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanResult. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this ContainerScanResult. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this ContainerScanResult. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this ContainerScanResult. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this ContainerScanResult. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def problem_count(self): + """ + Gets the problem_count of this ContainerScanResult. + Total number of problems found in this scan + + + :return: The problem_count of this ContainerScanResult. + :rtype: int + """ + return self._problem_count + + @problem_count.setter + def problem_count(self, problem_count): + """ + Sets the problem_count of this ContainerScanResult. + Total number of problems found in this scan + + + :param problem_count: The problem_count of this ContainerScanResult. + :type: int + """ + self._problem_count = problem_count + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this ContainerScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this ContainerScanResult. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this ContainerScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this ContainerScanResult. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this ContainerScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this ContainerScanResult. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this ContainerScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this ContainerScanResult. + :type: datetime + """ + self._time_finished = time_finished + + @property + def problems(self): + """ + **[Required]** Gets the problems of this ContainerScanResult. + List of problems found in this scan + + + :return: The problems of this ContainerScanResult. + :rtype: list[oci.vulnerability_scanning.models.ContainerScanResultProblem] + """ + return self._problems + + @problems.setter + def problems(self, problems): + """ + Sets the problems of this ContainerScanResult. + List of problems found in this scan + + + :param problems: The problems of this ContainerScanResult. + :type: list[oci.vulnerability_scanning.models.ContainerScanResultProblem] + """ + self._problems = problems + + 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/vulnerability_scanning/models/container_scan_result_problem.py b/src/oci/vulnerability_scanning/models/container_scan_result_problem.py new file mode 100644 index 0000000000..df600ecc03 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_result_problem.py @@ -0,0 +1,242 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanResultProblem(object): + """ + A problem found in a container scan + """ + + #: A constant which can be used with the severity property of a ContainerScanResultProblem. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a ContainerScanResultProblem. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a ContainerScanResultProblem. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a ContainerScanResultProblem. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a ContainerScanResultProblem. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the state property of a ContainerScanResultProblem. + #: This constant has a value of "OPEN" + STATE_OPEN = "OPEN" + + #: A constant which can be used with the state property of a ContainerScanResultProblem. + #: This constant has a value of "FIXED" + STATE_FIXED = "FIXED" + + #: A constant which can be used with the state property of a ContainerScanResultProblem. + #: This constant has a value of "NOT_APPLICABLE" + STATE_NOT_APPLICABLE = "NOT_APPLICABLE" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanResultProblem 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 ContainerScanResultProblem. + :type name: str + + :param description: + The value to assign to the description property of this ContainerScanResultProblem. + :type description: str + + :param severity: + The value to assign to the severity property of this ContainerScanResultProblem. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param state: + The value to assign to the state property of this ContainerScanResultProblem. + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param cve_reference: + The value to assign to the cve_reference property of this ContainerScanResultProblem. + :type cve_reference: str + + """ + self.swagger_types = { + 'name': 'str', + 'description': 'str', + 'severity': 'str', + 'state': 'str', + 'cve_reference': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'description': 'description', + 'severity': 'severity', + 'state': 'state', + 'cve_reference': 'cveReference' + } + + self._name = None + self._description = None + self._severity = None + self._state = None + self._cve_reference = None + + @property + def name(self): + """ + **[Required]** Gets the name of this ContainerScanResultProblem. + Name of the problem + + + :return: The name of this ContainerScanResultProblem. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ContainerScanResultProblem. + Name of the problem + + + :param name: The name of this ContainerScanResultProblem. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ContainerScanResultProblem. + Problem description + + + :return: The description of this ContainerScanResultProblem. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ContainerScanResultProblem. + Problem description + + + :param description: The description of this ContainerScanResultProblem. + :type: str + """ + self._description = description + + @property + def severity(self): + """ + **[Required]** Gets the severity of this ContainerScanResultProblem. + Problem severity + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this ContainerScanResultProblem. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this ContainerScanResultProblem. + Problem severity + + + :param severity: The severity of this ContainerScanResultProblem. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def state(self): + """ + Gets the state of this ContainerScanResultProblem. + State of the vulnerability + + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this ContainerScanResultProblem. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ContainerScanResultProblem. + State of the vulnerability + + + :param state: The state of this ContainerScanResultProblem. + :type: str + """ + allowed_values = ["OPEN", "FIXED", "NOT_APPLICABLE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = state + + @property + def cve_reference(self): + """ + Gets the cve_reference of this ContainerScanResultProblem. + Reference to problem MITRE CVE ID + + + :return: The cve_reference of this ContainerScanResultProblem. + :rtype: str + """ + return self._cve_reference + + @cve_reference.setter + def cve_reference(self, cve_reference): + """ + Sets the cve_reference of this ContainerScanResultProblem. + Reference to problem MITRE CVE ID + + + :param cve_reference: The cve_reference of this ContainerScanResultProblem. + :type: str + """ + self._cve_reference = cve_reference + + 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/vulnerability_scanning/models/container_scan_result_summary.py b/src/oci/vulnerability_scanning/models/container_scan_result_summary.py new file mode 100644 index 0000000000..71c9f01c01 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_result_summary.py @@ -0,0 +1,331 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanResultSummary(object): + """ + A summary of a result for a container scan + """ + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResultSummary. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResultSummary. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResultSummary. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResultSummary. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a ContainerScanResultSummary. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanResultSummary 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 ContainerScanResultSummary. + :type id: str + + :param repository: + The value to assign to the repository property of this ContainerScanResultSummary. + :type repository: str + + :param image: + The value to assign to the image property of this ContainerScanResultSummary. + :type image: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanResultSummary. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this ContainerScanResultSummary. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param problem_count: + The value to assign to the problem_count property of this ContainerScanResultSummary. + :type problem_count: int + + :param time_started: + The value to assign to the time_started property of this ContainerScanResultSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this ContainerScanResultSummary. + :type time_finished: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'repository': 'str', + 'image': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'problem_count': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'repository': 'repository', + 'image': 'image', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'problem_count': 'problemCount', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._id = None + self._repository = None + self._image = None + self._compartment_id = None + self._highest_problem_severity = None + self._problem_count = None + self._time_started = None + self._time_finished = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanResultSummary. + The `OCID`__ of container scan result. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanResultSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanResultSummary. + The `OCID`__ of container scan result. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanResultSummary. + :type: str + """ + self._id = id + + @property + def repository(self): + """ + **[Required]** Gets the repository of this ContainerScanResultSummary. + Repository in which the container image scanned is located + + + :return: The repository of this ContainerScanResultSummary. + :rtype: str + """ + return self._repository + + @repository.setter + def repository(self, repository): + """ + Sets the repository of this ContainerScanResultSummary. + Repository in which the container image scanned is located + + + :param repository: The repository of this ContainerScanResultSummary. + :type: str + """ + self._repository = repository + + @property + def image(self): + """ + **[Required]** Gets the image of this ContainerScanResultSummary. + Image name + + + :return: The image of this ContainerScanResultSummary. + :rtype: str + """ + return self._image + + @image.setter + def image(self, image): + """ + Sets the image of this ContainerScanResultSummary. + Image name + + + :param image: The image of this ContainerScanResultSummary. + :type: str + """ + self._image = image + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanResultSummary. + The `OCID`__ of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanResultSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanResultSummary. + The `OCID`__ of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanResultSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this ContainerScanResultSummary. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this ContainerScanResultSummary. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this ContainerScanResultSummary. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this ContainerScanResultSummary. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def problem_count(self): + """ + **[Required]** Gets the problem_count of this ContainerScanResultSummary. + Total number of problems found in this scan + + + :return: The problem_count of this ContainerScanResultSummary. + :rtype: int + """ + return self._problem_count + + @problem_count.setter + def problem_count(self, problem_count): + """ + Sets the problem_count of this ContainerScanResultSummary. + Total number of problems found in this scan + + + :param problem_count: The problem_count of this ContainerScanResultSummary. + :type: int + """ + self._problem_count = problem_count + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this ContainerScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this ContainerScanResultSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this ContainerScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this ContainerScanResultSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this ContainerScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this ContainerScanResultSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this ContainerScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this ContainerScanResultSummary. + :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/vulnerability_scanning/models/container_scan_result_summary_collection.py b/src/oci/vulnerability_scanning/models/container_scan_result_summary_collection.py new file mode 100644 index 0000000000..0e343e9e5e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_result_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanResultSummaryCollection(object): + """ + A collection of ContainerScanResultSummary + """ + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanResultSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this ContainerScanResultSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.ContainerScanResultSummary] + + """ + self.swagger_types = { + 'items': 'list[ContainerScanResultSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ContainerScanResultSummaryCollection. + The ContainerScanResultSummary objects in the collection + + + :return: The items of this ContainerScanResultSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.ContainerScanResultSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ContainerScanResultSummaryCollection. + The ContainerScanResultSummary objects in the collection + + + :param items: The items of this ContainerScanResultSummaryCollection. + :type: list[oci.vulnerability_scanning.models.ContainerScanResultSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/container_scan_settings.py b/src/oci/vulnerability_scanning/models/container_scan_settings.py new file mode 100644 index 0000000000..06cbe840ef --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_settings.py @@ -0,0 +1,86 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanSettings(object): + """ + A collection of container scan settings + """ + + #: A constant which can be used with the scan_level property of a ContainerScanSettings. + #: This constant has a value of "NONE" + SCAN_LEVEL_NONE = "NONE" + + #: A constant which can be used with the scan_level property of a ContainerScanSettings. + #: This constant has a value of "STANDARD" + SCAN_LEVEL_STANDARD = "STANDARD" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanSettings object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param scan_level: + The value to assign to the scan_level property of this ContainerScanSettings. + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type scan_level: str + + """ + self.swagger_types = { + 'scan_level': 'str' + } + + self.attribute_map = { + 'scan_level': 'scanLevel' + } + + self._scan_level = None + + @property + def scan_level(self): + """ + **[Required]** Gets the scan_level of this ContainerScanSettings. + The scan level + + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The scan_level of this ContainerScanSettings. + :rtype: str + """ + return self._scan_level + + @scan_level.setter + def scan_level(self, scan_level): + """ + Sets the scan_level of this ContainerScanSettings. + The scan level + + + :param scan_level: The scan_level of this ContainerScanSettings. + :type: str + """ + allowed_values = ["NONE", "STANDARD"] + if not value_allowed_none_or_none_sentinel(scan_level, allowed_values): + scan_level = 'UNKNOWN_ENUM_VALUE' + self._scan_level = scan_level + + 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/vulnerability_scanning/models/container_scan_target.py b/src/oci/vulnerability_scanning/models/container_scan_target.py new file mode 100644 index 0000000000..f023a82335 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_target.py @@ -0,0 +1,461 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanTarget(object): + """ + A container scan target (application of a container scan recipe to the registry or list of repos) + """ + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTarget. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanTarget 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 ContainerScanTarget. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ContainerScanTarget. + :type display_name: str + + :param description: + The value to assign to the description property of this ContainerScanTarget. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanTarget. + :type compartment_id: str + + :param target_registry: + The value to assign to the target_registry property of this ContainerScanTarget. + :type target_registry: oci.vulnerability_scanning.models.ContainerScanRegistry + + :param container_scan_recipe_id: + The value to assign to the container_scan_recipe_id property of this ContainerScanTarget. + :type container_scan_recipe_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ContainerScanTarget. + 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 time_created: + The value to assign to the time_created property of this ContainerScanTarget. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ContainerScanTarget. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this ContainerScanTarget. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ContainerScanTarget. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ContainerScanTarget. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'target_registry': 'ContainerScanRegistry', + 'container_scan_recipe_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'target_registry': 'targetRegistry', + 'container_scan_recipe_id': 'containerScanRecipeId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._target_registry = None + self._container_scan_recipe_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanTarget. + The `OCID`__ of container scan target. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanTarget. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanTarget. + The `OCID`__ of container scan target. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanTarget. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ContainerScanTarget. + User friendly name of container scan target + + + :return: The display_name of this ContainerScanTarget. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContainerScanTarget. + User friendly name of container scan target + + + :param display_name: The display_name of this ContainerScanTarget. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this ContainerScanTarget. + Target description. + + + :return: The description of this ContainerScanTarget. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ContainerScanTarget. + Target description. + + + :param description: The description of this ContainerScanTarget. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanTarget. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanTarget. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanTarget. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanTarget. + :type: str + """ + self._compartment_id = compartment_id + + @property + def target_registry(self): + """ + Gets the target_registry of this ContainerScanTarget. + + :return: The target_registry of this ContainerScanTarget. + :rtype: oci.vulnerability_scanning.models.ContainerScanRegistry + """ + return self._target_registry + + @target_registry.setter + def target_registry(self, target_registry): + """ + Sets the target_registry of this ContainerScanTarget. + + :param target_registry: The target_registry of this ContainerScanTarget. + :type: oci.vulnerability_scanning.models.ContainerScanRegistry + """ + self._target_registry = target_registry + + @property + def container_scan_recipe_id(self): + """ + **[Required]** Gets the container_scan_recipe_id of this ContainerScanTarget. + ID of the container scan recipe this target applies. + + + :return: The container_scan_recipe_id of this ContainerScanTarget. + :rtype: str + """ + return self._container_scan_recipe_id + + @container_scan_recipe_id.setter + def container_scan_recipe_id(self, container_scan_recipe_id): + """ + Sets the container_scan_recipe_id of this ContainerScanTarget. + ID of the container scan recipe this target applies. + + + :param container_scan_recipe_id: The container_scan_recipe_id of this ContainerScanTarget. + :type: str + """ + self._container_scan_recipe_id = container_scan_recipe_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ContainerScanTarget. + The current state of the config. + + 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 ContainerScanTarget. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ContainerScanTarget. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this ContainerScanTarget. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this ContainerScanTarget. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this ContainerScanTarget. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ContainerScanTarget. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this ContainerScanTarget. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this ContainerScanTarget. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this ContainerScanTarget. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ContainerScanTarget. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this ContainerScanTarget. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ContainerScanTarget. + 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 ContainerScanTarget. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ContainerScanTarget. + 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 ContainerScanTarget. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ContainerScanTarget. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ContainerScanTarget. + :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 ContainerScanTarget. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ContainerScanTarget. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ContainerScanTarget. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this ContainerScanTarget. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this ContainerScanTarget. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this ContainerScanTarget. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/container_scan_target_summary.py b/src/oci/vulnerability_scanning/models/container_scan_target_summary.py new file mode 100644 index 0000000000..f6b05d23d1 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_target_summary.py @@ -0,0 +1,403 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanTargetSummary(object): + """ + Summary of a container scan target (application of a container scan recipe to the registry or list of repos) + """ + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a ContainerScanTargetSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanTargetSummary 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 ContainerScanTargetSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ContainerScanTargetSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this ContainerScanTargetSummary. + :type compartment_id: str + + :param container_scan_recipe_id: + The value to assign to the container_scan_recipe_id property of this ContainerScanTargetSummary. + :type container_scan_recipe_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ContainerScanTargetSummary. + 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 time_created: + The value to assign to the time_created property of this ContainerScanTargetSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ContainerScanTargetSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this ContainerScanTargetSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ContainerScanTargetSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ContainerScanTargetSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'container_scan_recipe_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'container_scan_recipe_id': 'containerScanRecipeId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._container_scan_recipe_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ContainerScanTargetSummary. + The `OCID`__ of container scan target. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The id of this ContainerScanTargetSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ContainerScanTargetSummary. + The `OCID`__ of container scan target. Immutable and generated on creation. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param id: The id of this ContainerScanTargetSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ContainerScanTargetSummary. + User friendly name of container scan target + + + :return: The display_name of this ContainerScanTargetSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContainerScanTargetSummary. + User friendly name of container scan target + + + :param display_name: The display_name of this ContainerScanTargetSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ContainerScanTargetSummary. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ContainerScanTargetSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ContainerScanTargetSummary. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ContainerScanTargetSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def container_scan_recipe_id(self): + """ + **[Required]** Gets the container_scan_recipe_id of this ContainerScanTargetSummary. + ID of the container scan recipe this target applies. + + + :return: The container_scan_recipe_id of this ContainerScanTargetSummary. + :rtype: str + """ + return self._container_scan_recipe_id + + @container_scan_recipe_id.setter + def container_scan_recipe_id(self, container_scan_recipe_id): + """ + Sets the container_scan_recipe_id of this ContainerScanTargetSummary. + ID of the container scan recipe this target applies. + + + :param container_scan_recipe_id: The container_scan_recipe_id of this ContainerScanTargetSummary. + :type: str + """ + self._container_scan_recipe_id = container_scan_recipe_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this ContainerScanTargetSummary. + The current state of the config. + + 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 ContainerScanTargetSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this ContainerScanTargetSummary. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this ContainerScanTargetSummary. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this ContainerScanTargetSummary. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this ContainerScanTargetSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ContainerScanTargetSummary. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this ContainerScanTargetSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this ContainerScanTargetSummary. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this ContainerScanTargetSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ContainerScanTargetSummary. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this ContainerScanTargetSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ContainerScanTargetSummary. + 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 ContainerScanTargetSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ContainerScanTargetSummary. + 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 ContainerScanTargetSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ContainerScanTargetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this ContainerScanTargetSummary. + :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 ContainerScanTargetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this ContainerScanTargetSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this ContainerScanTargetSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this ContainerScanTargetSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this ContainerScanTargetSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this ContainerScanTargetSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/container_scan_target_summary_collection.py b/src/oci/vulnerability_scanning/models/container_scan_target_summary_collection.py new file mode 100644 index 0000000000..fd1052a7a1 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/container_scan_target_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ContainerScanTargetSummaryCollection(object): + """ + A collection of ContainerScanTargetSummary objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new ContainerScanTargetSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this ContainerScanTargetSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.ContainerScanTargetSummary] + + """ + self.swagger_types = { + 'items': 'list[ContainerScanTargetSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ContainerScanTargetSummaryCollection. + The ContainerScanTargetSummary objects in the collection + + + :return: The items of this ContainerScanTargetSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.ContainerScanTargetSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ContainerScanTargetSummaryCollection. + The ContainerScanTargetSummary objects in the collection + + + :param items: The items of this ContainerScanTargetSummaryCollection. + :type: list[oci.vulnerability_scanning.models.ContainerScanTargetSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/create_container_scan_recipe_details.py b/src/oci/vulnerability_scanning/models/create_container_scan_recipe_details.py new file mode 100644 index 0000000000..6146f8efff --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_container_scan_recipe_details.py @@ -0,0 +1,198 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateContainerScanRecipeDetails(object): + """ + The information for a new container scan recipe + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateContainerScanRecipeDetails 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 CreateContainerScanRecipeDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateContainerScanRecipeDetails. + :type compartment_id: str + + :param scan_settings: + The value to assign to the scan_settings property of this CreateContainerScanRecipeDetails. + :type scan_settings: oci.vulnerability_scanning.models.ContainerScanSettings + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateContainerScanRecipeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateContainerScanRecipeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'scan_settings': 'ContainerScanSettings', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'scan_settings': 'scanSettings', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._scan_settings = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateContainerScanRecipeDetails. + User friendly name of container scan recipe. If not present, will be auto-generated. + + + :return: The display_name of this CreateContainerScanRecipeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateContainerScanRecipeDetails. + User friendly name of container scan recipe. If not present, will be auto-generated. + + + :param display_name: The display_name of this CreateContainerScanRecipeDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateContainerScanRecipeDetails. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreateContainerScanRecipeDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateContainerScanRecipeDetails. + The `OCID`__ of the container scan recipe's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreateContainerScanRecipeDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def scan_settings(self): + """ + **[Required]** Gets the scan_settings of this CreateContainerScanRecipeDetails. + + :return: The scan_settings of this CreateContainerScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.ContainerScanSettings + """ + return self._scan_settings + + @scan_settings.setter + def scan_settings(self, scan_settings): + """ + Sets the scan_settings of this CreateContainerScanRecipeDetails. + + :param scan_settings: The scan_settings of this CreateContainerScanRecipeDetails. + :type: oci.vulnerability_scanning.models.ContainerScanSettings + """ + self._scan_settings = scan_settings + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateContainerScanRecipeDetails. + 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 CreateContainerScanRecipeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateContainerScanRecipeDetails. + 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 CreateContainerScanRecipeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateContainerScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateContainerScanRecipeDetails. + :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 CreateContainerScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateContainerScanRecipeDetails. + :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/vulnerability_scanning/models/create_container_scan_registry_details.py b/src/oci/vulnerability_scanning/models/create_container_scan_registry_details.py new file mode 100644 index 0000000000..e48970b6dd --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_container_scan_registry_details.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateContainerScanRegistryDetails(object): + """ + Registry information for a container scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateContainerScanRegistryDetails 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.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this CreateContainerScanRegistryDetails. + :type type: str + + :param url: + The value to assign to the url property of this CreateContainerScanRegistryDetails. + :type url: str + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url' + } + + self._type = None + self._url = 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['type'] + + if type == 'OCIR': + return 'CreateOcirContainerScanRegistryDetails' + else: + return 'CreateContainerScanRegistryDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this CreateContainerScanRegistryDetails. + The scan level + + + :return: The type of this CreateContainerScanRegistryDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this CreateContainerScanRegistryDetails. + The scan level + + + :param type: The type of this CreateContainerScanRegistryDetails. + :type: str + """ + self._type = type + + @property + def url(self): + """ + Gets the url of this CreateContainerScanRegistryDetails. + URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). + + + :return: The url of this CreateContainerScanRegistryDetails. + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """ + Sets the url of this CreateContainerScanRegistryDetails. + URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). + + + :param url: The url of this CreateContainerScanRegistryDetails. + :type: str + """ + self._url = url + + 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/vulnerability_scanning/models/create_container_scan_target_details.py b/src/oci/vulnerability_scanning/models/create_container_scan_target_details.py new file mode 100644 index 0000000000..6d4524c624 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_container_scan_target_details.py @@ -0,0 +1,260 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateContainerScanTargetDetails(object): + """ + The information for a new container scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateContainerScanTargetDetails 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 CreateContainerScanTargetDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateContainerScanTargetDetails. + :type compartment_id: str + + :param description: + The value to assign to the description property of this CreateContainerScanTargetDetails. + :type description: str + + :param target_registry: + The value to assign to the target_registry property of this CreateContainerScanTargetDetails. + :type target_registry: oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails + + :param container_scan_recipe_id: + The value to assign to the container_scan_recipe_id property of this CreateContainerScanTargetDetails. + :type container_scan_recipe_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateContainerScanTargetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateContainerScanTargetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'description': 'str', + 'target_registry': 'CreateContainerScanRegistryDetails', + 'container_scan_recipe_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'description': 'description', + 'target_registry': 'targetRegistry', + 'container_scan_recipe_id': 'containerScanRecipeId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._description = None + self._target_registry = None + self._container_scan_recipe_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateContainerScanTargetDetails. + User friendly name of container scan target. If not present, will be auto-generated. + + + :return: The display_name of this CreateContainerScanTargetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateContainerScanTargetDetails. + User friendly name of container scan target. If not present, will be auto-generated. + + + :param display_name: The display_name of this CreateContainerScanTargetDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateContainerScanTargetDetails. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreateContainerScanTargetDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateContainerScanTargetDetails. + The `OCID`__ of the container scan target's compartment + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreateContainerScanTargetDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def description(self): + """ + Gets the description of this CreateContainerScanTargetDetails. + Target description. + + + :return: The description of this CreateContainerScanTargetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateContainerScanTargetDetails. + Target description. + + + :param description: The description of this CreateContainerScanTargetDetails. + :type: str + """ + self._description = description + + @property + def target_registry(self): + """ + **[Required]** Gets the target_registry of this CreateContainerScanTargetDetails. + + :return: The target_registry of this CreateContainerScanTargetDetails. + :rtype: oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails + """ + return self._target_registry + + @target_registry.setter + def target_registry(self, target_registry): + """ + Sets the target_registry of this CreateContainerScanTargetDetails. + + :param target_registry: The target_registry of this CreateContainerScanTargetDetails. + :type: oci.vulnerability_scanning.models.CreateContainerScanRegistryDetails + """ + self._target_registry = target_registry + + @property + def container_scan_recipe_id(self): + """ + **[Required]** Gets the container_scan_recipe_id of this CreateContainerScanTargetDetails. + ID of the container scan recipe this target applies. + + + :return: The container_scan_recipe_id of this CreateContainerScanTargetDetails. + :rtype: str + """ + return self._container_scan_recipe_id + + @container_scan_recipe_id.setter + def container_scan_recipe_id(self, container_scan_recipe_id): + """ + Sets the container_scan_recipe_id of this CreateContainerScanTargetDetails. + ID of the container scan recipe this target applies. + + + :param container_scan_recipe_id: The container_scan_recipe_id of this CreateContainerScanTargetDetails. + :type: str + """ + self._container_scan_recipe_id = container_scan_recipe_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateContainerScanTargetDetails. + 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 CreateContainerScanTargetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateContainerScanTargetDetails. + 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 CreateContainerScanTargetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateContainerScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateContainerScanTargetDetails. + :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 CreateContainerScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateContainerScanTargetDetails. + :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/vulnerability_scanning/models/create_host_scan_recipe_details.py b/src/oci/vulnerability_scanning/models/create_host_scan_recipe_details.py new file mode 100644 index 0000000000..44ce20756e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_host_scan_recipe_details.py @@ -0,0 +1,248 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateHostScanRecipeDetails(object): + """ + The information for a new host scan recipe + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateHostScanRecipeDetails 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 CreateHostScanRecipeDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateHostScanRecipeDetails. + :type compartment_id: str + + :param port_settings: + The value to assign to the port_settings property of this CreateHostScanRecipeDetails. + :type port_settings: oci.vulnerability_scanning.models.HostScanPortSettings + + :param agent_settings: + The value to assign to the agent_settings property of this CreateHostScanRecipeDetails. + :type agent_settings: oci.vulnerability_scanning.models.HostScanAgentSettings + + :param schedule: + The value to assign to the schedule property of this CreateHostScanRecipeDetails. + :type schedule: oci.vulnerability_scanning.models.Schedule + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateHostScanRecipeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateHostScanRecipeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'port_settings': 'HostScanPortSettings', + 'agent_settings': 'HostScanAgentSettings', + 'schedule': 'Schedule', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'port_settings': 'portSettings', + 'agent_settings': 'agentSettings', + 'schedule': 'schedule', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._port_settings = None + self._agent_settings = None + self._schedule = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateHostScanRecipeDetails. + Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information. + + + :return: The display_name of this CreateHostScanRecipeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateHostScanRecipeDetails. + Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateHostScanRecipeDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateHostScanRecipeDetails. + Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned + + + :return: The compartment_id of this CreateHostScanRecipeDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateHostScanRecipeDetails. + Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned + + + :param compartment_id: The compartment_id of this CreateHostScanRecipeDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def port_settings(self): + """ + **[Required]** Gets the port_settings of this CreateHostScanRecipeDetails. + + :return: The port_settings of this CreateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.HostScanPortSettings + """ + return self._port_settings + + @port_settings.setter + def port_settings(self, port_settings): + """ + Sets the port_settings of this CreateHostScanRecipeDetails. + + :param port_settings: The port_settings of this CreateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.HostScanPortSettings + """ + self._port_settings = port_settings + + @property + def agent_settings(self): + """ + **[Required]** Gets the agent_settings of this CreateHostScanRecipeDetails. + + :return: The agent_settings of this CreateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + return self._agent_settings + + @agent_settings.setter + def agent_settings(self, agent_settings): + """ + Sets the agent_settings of this CreateHostScanRecipeDetails. + + :param agent_settings: The agent_settings of this CreateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + self._agent_settings = agent_settings + + @property + def schedule(self): + """ + **[Required]** Gets the schedule of this CreateHostScanRecipeDetails. + + :return: The schedule of this CreateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.Schedule + """ + return self._schedule + + @schedule.setter + def schedule(self, schedule): + """ + Sets the schedule of this CreateHostScanRecipeDetails. + + :param schedule: The schedule of this CreateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.Schedule + """ + self._schedule = schedule + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateHostScanRecipeDetails. + 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 CreateHostScanRecipeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateHostScanRecipeDetails. + 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 CreateHostScanRecipeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateHostScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateHostScanRecipeDetails. + :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 CreateHostScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateHostScanRecipeDetails. + :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/vulnerability_scanning/models/create_host_scan_target_details.py b/src/oci/vulnerability_scanning/models/create_host_scan_target_details.py new file mode 100644 index 0000000000..9b6618ea6d --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_host_scan_target_details.py @@ -0,0 +1,291 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateHostScanTargetDetails(object): + """ + The information for a new host scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateHostScanTargetDetails 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 CreateHostScanTargetDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateHostScanTargetDetails. + :type compartment_id: str + + :param description: + The value to assign to the description property of this CreateHostScanTargetDetails. + :type description: str + + :param target_compartment_id: + The value to assign to the target_compartment_id property of this CreateHostScanTargetDetails. + :type target_compartment_id: str + + :param instance_ids: + The value to assign to the instance_ids property of this CreateHostScanTargetDetails. + :type instance_ids: list[str] + + :param host_scan_recipe_id: + The value to assign to the host_scan_recipe_id property of this CreateHostScanTargetDetails. + :type host_scan_recipe_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateHostScanTargetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateHostScanTargetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'description': 'str', + 'target_compartment_id': 'str', + 'instance_ids': 'list[str]', + 'host_scan_recipe_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'description': 'description', + 'target_compartment_id': 'targetCompartmentId', + 'instance_ids': 'instanceIds', + 'host_scan_recipe_id': 'hostScanRecipeId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._description = None + self._target_compartment_id = None + self._instance_ids = None + self._host_scan_recipe_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateHostScanTargetDetails. + Target identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information. + + + :return: The display_name of this CreateHostScanTargetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateHostScanTargetDetails. + Target identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information. + + + :param display_name: The display_name of this CreateHostScanTargetDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateHostScanTargetDetails. + Compartment ID of the object (this). + + + :return: The compartment_id of this CreateHostScanTargetDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateHostScanTargetDetails. + Compartment ID of the object (this). + + + :param compartment_id: The compartment_id of this CreateHostScanTargetDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def description(self): + """ + Gets the description of this CreateHostScanTargetDetails. + Target description. + + + :return: The description of this CreateHostScanTargetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateHostScanTargetDetails. + Target description. + + + :param description: The description of this CreateHostScanTargetDetails. + :type: str + """ + self._description = description + + @property + def target_compartment_id(self): + """ + **[Required]** Gets the target_compartment_id of this CreateHostScanTargetDetails. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :return: The target_compartment_id of this CreateHostScanTargetDetails. + :rtype: str + """ + return self._target_compartment_id + + @target_compartment_id.setter + def target_compartment_id(self, target_compartment_id): + """ + Sets the target_compartment_id of this CreateHostScanTargetDetails. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :param target_compartment_id: The target_compartment_id of this CreateHostScanTargetDetails. + :type: str + """ + self._target_compartment_id = target_compartment_id + + @property + def instance_ids(self): + """ + Gets the instance_ids of this CreateHostScanTargetDetails. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :return: The instance_ids of this CreateHostScanTargetDetails. + :rtype: list[str] + """ + return self._instance_ids + + @instance_ids.setter + def instance_ids(self, instance_ids): + """ + Sets the instance_ids of this CreateHostScanTargetDetails. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :param instance_ids: The instance_ids of this CreateHostScanTargetDetails. + :type: list[str] + """ + self._instance_ids = instance_ids + + @property + def host_scan_recipe_id(self): + """ + **[Required]** Gets the host_scan_recipe_id of this CreateHostScanTargetDetails. + ID of the host scan recipe this target applies. + + + :return: The host_scan_recipe_id of this CreateHostScanTargetDetails. + :rtype: str + """ + return self._host_scan_recipe_id + + @host_scan_recipe_id.setter + def host_scan_recipe_id(self, host_scan_recipe_id): + """ + Sets the host_scan_recipe_id of this CreateHostScanTargetDetails. + ID of the host scan recipe this target applies. + + + :param host_scan_recipe_id: The host_scan_recipe_id of this CreateHostScanTargetDetails. + :type: str + """ + self._host_scan_recipe_id = host_scan_recipe_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateHostScanTargetDetails. + 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 CreateHostScanTargetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateHostScanTargetDetails. + 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 CreateHostScanTargetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateHostScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateHostScanTargetDetails. + :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 CreateHostScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateHostScanTargetDetails. + :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/vulnerability_scanning/models/create_ocir_container_scan_registry_details.py b/src/oci/vulnerability_scanning/models/create_ocir_container_scan_registry_details.py new file mode 100644 index 0000000000..79c378db57 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/create_ocir_container_scan_registry_details.py @@ -0,0 +1,121 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_container_scan_registry_details import CreateContainerScanRegistryDetails +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 CreateOcirContainerScanRegistryDetails(CreateContainerScanRegistryDetails): + """ + Registry information for a OCI Registry target + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateOcirContainerScanRegistryDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.vulnerability_scanning.models.CreateOcirContainerScanRegistryDetails.type` attribute + of this class is ``OCIR`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this CreateOcirContainerScanRegistryDetails. + :type type: str + + :param url: + The value to assign to the url property of this CreateOcirContainerScanRegistryDetails. + :type url: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateOcirContainerScanRegistryDetails. + :type compartment_id: str + + :param repositories: + The value to assign to the repositories property of this CreateOcirContainerScanRegistryDetails. + :type repositories: list[str] + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str', + 'compartment_id': 'str', + 'repositories': 'list[str]' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url', + 'compartment_id': 'compartmentId', + 'repositories': 'repositories' + } + + self._type = None + self._url = None + self._compartment_id = None + self._repositories = None + self._type = 'OCIR' + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateOcirContainerScanRegistryDetails. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreateOcirContainerScanRegistryDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateOcirContainerScanRegistryDetails. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreateOcirContainerScanRegistryDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def repositories(self): + """ + Gets the repositories of this CreateOcirContainerScanRegistryDetails. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :return: The repositories of this CreateOcirContainerScanRegistryDetails. + :rtype: list[str] + """ + return self._repositories + + @repositories.setter + def repositories(self, repositories): + """ + Sets the repositories of this CreateOcirContainerScanRegistryDetails. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :param repositories: The repositories of this CreateOcirContainerScanRegistryDetails. + :type: list[str] + """ + self._repositories = repositories + + 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/vulnerability_scanning/models/cve_details.py b/src/oci/vulnerability_scanning/models/cve_details.py new file mode 100644 index 0000000000..eca022d2fa --- /dev/null +++ b/src/oci/vulnerability_scanning/models/cve_details.py @@ -0,0 +1,256 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CveDetails(object): + """ + Details on a CVE + """ + + def __init__(self, **kwargs): + """ + Initializes a new CveDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cve_reference: + The value to assign to the cve_reference property of this CveDetails. + :type cve_reference: str + + :param title: + The value to assign to the title property of this CveDetails. + :type title: str + + :param description: + The value to assign to the description property of this CveDetails. + :type description: str + + :param related_cve_reference: + The value to assign to the related_cve_reference property of this CveDetails. + :type related_cve_reference: str + + :param cvss3: + The value to assign to the cvss3 property of this CveDetails. + :type cvss3: str + + :param time_published: + The value to assign to the time_published property of this CveDetails. + :type time_published: datetime + + :param time_updated: + The value to assign to the time_updated property of this CveDetails. + :type time_updated: datetime + + """ + self.swagger_types = { + 'cve_reference': 'str', + 'title': 'str', + 'description': 'str', + 'related_cve_reference': 'str', + 'cvss3': 'str', + 'time_published': 'datetime', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'cve_reference': 'cveReference', + 'title': 'title', + 'description': 'description', + 'related_cve_reference': 'relatedCveReference', + 'cvss3': 'cvss3', + 'time_published': 'timePublished', + 'time_updated': 'timeUpdated' + } + + self._cve_reference = None + self._title = None + self._description = None + self._related_cve_reference = None + self._cvss3 = None + self._time_published = None + self._time_updated = None + + @property + def cve_reference(self): + """ + **[Required]** Gets the cve_reference of this CveDetails. + CVE ID + + + :return: The cve_reference of this CveDetails. + :rtype: str + """ + return self._cve_reference + + @cve_reference.setter + def cve_reference(self, cve_reference): + """ + Sets the cve_reference of this CveDetails. + CVE ID + + + :param cve_reference: The cve_reference of this CveDetails. + :type: str + """ + self._cve_reference = cve_reference + + @property + def title(self): + """ + **[Required]** Gets the title of this CveDetails. + Vulnerability title + + + :return: The title of this CveDetails. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this CveDetails. + Vulnerability title + + + :param title: The title of this CveDetails. + :type: str + """ + self._title = title + + @property + def description(self): + """ + Gets the description of this CveDetails. + CVE description + + + :return: The description of this CveDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CveDetails. + CVE description + + + :param description: The description of this CveDetails. + :type: str + """ + self._description = description + + @property + def related_cve_reference(self): + """ + Gets the related_cve_reference of this CveDetails. + ID of related CVE, if applicable + + + :return: The related_cve_reference of this CveDetails. + :rtype: str + """ + return self._related_cve_reference + + @related_cve_reference.setter + def related_cve_reference(self, related_cve_reference): + """ + Sets the related_cve_reference of this CveDetails. + ID of related CVE, if applicable + + + :param related_cve_reference: The related_cve_reference of this CveDetails. + :type: str + """ + self._related_cve_reference = related_cve_reference + + @property + def cvss3(self): + """ + **[Required]** Gets the cvss3 of this CveDetails. + CVSS 3 Score + + + :return: The cvss3 of this CveDetails. + :rtype: str + """ + return self._cvss3 + + @cvss3.setter + def cvss3(self, cvss3): + """ + Sets the cvss3 of this CveDetails. + CVSS 3 Score + + + :param cvss3: The cvss3 of this CveDetails. + :type: str + """ + self._cvss3 = cvss3 + + @property + def time_published(self): + """ + **[Required]** Gets the time_published of this CveDetails. + Date/time the CVE was published + + + :return: The time_published of this CveDetails. + :rtype: datetime + """ + return self._time_published + + @time_published.setter + def time_published(self, time_published): + """ + Sets the time_published of this CveDetails. + Date/time the CVE was published + + + :param time_published: The time_published of this CveDetails. + :type: datetime + """ + self._time_published = time_published + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this CveDetails. + Date/time the CVE was last modified + + + :return: The time_updated of this CveDetails. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this CveDetails. + Date/time the CVE was last modified + + + :param time_updated: The time_updated of this CveDetails. + :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/vulnerability_scanning/models/export_host_agent_scan_result_csv_details.py b/src/oci/vulnerability_scanning/models/export_host_agent_scan_result_csv_details.py new file mode 100644 index 0000000000..6fadc10ef1 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/export_host_agent_scan_result_csv_details.py @@ -0,0 +1,266 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ExportHostAgentScanResultCsvDetails(object): + """ + Details for a HostAgentScan list export to CSV action + """ + + #: A constant which can be used with the highest_problem_severity property of a ExportHostAgentScanResultCsvDetails. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a ExportHostAgentScanResultCsvDetails. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a ExportHostAgentScanResultCsvDetails. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a ExportHostAgentScanResultCsvDetails. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a ExportHostAgentScanResultCsvDetails. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + def __init__(self, **kwargs): + """ + Initializes a new ExportHostAgentScanResultCsvDetails 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 ExportHostAgentScanResultCsvDetails. + :type compartment_id: str + + :param time_started_after: + The value to assign to the time_started_after property of this ExportHostAgentScanResultCsvDetails. + :type time_started_after: datetime + + :param time_started_before: + The value to assign to the time_started_before property of this ExportHostAgentScanResultCsvDetails. + :type time_started_before: datetime + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this ExportHostAgentScanResultCsvDetails. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + :type highest_problem_severity: str + + :param instance_id: + The value to assign to the instance_id property of this ExportHostAgentScanResultCsvDetails. + :type instance_id: str + + :param operating_system: + The value to assign to the operating_system property of this ExportHostAgentScanResultCsvDetails. + :type operating_system: str + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'time_started_after': 'datetime', + 'time_started_before': 'datetime', + 'highest_problem_severity': 'str', + 'instance_id': 'str', + 'operating_system': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'time_started_after': 'timeStartedAfter', + 'time_started_before': 'timeStartedBefore', + 'highest_problem_severity': 'highestProblemSeverity', + 'instance_id': 'instanceId', + 'operating_system': 'operatingSystem' + } + + self._compartment_id = None + self._time_started_after = None + self._time_started_before = None + self._highest_problem_severity = None + self._instance_id = None + self._operating_system = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ExportHostAgentScanResultCsvDetails. + The `OCID`__ of the compartment to list scans in. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ExportHostAgentScanResultCsvDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ExportHostAgentScanResultCsvDetails. + The `OCID`__ of the compartment to list scans in. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ExportHostAgentScanResultCsvDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_started_after(self): + """ + **[Required]** Gets the time_started_after of this ExportHostAgentScanResultCsvDetails. + Date and time after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started_after of this ExportHostAgentScanResultCsvDetails. + :rtype: datetime + """ + return self._time_started_after + + @time_started_after.setter + def time_started_after(self, time_started_after): + """ + Sets the time_started_after of this ExportHostAgentScanResultCsvDetails. + Date and time after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started_after: The time_started_after of this ExportHostAgentScanResultCsvDetails. + :type: datetime + """ + self._time_started_after = time_started_after + + @property + def time_started_before(self): + """ + **[Required]** Gets the time_started_before of this ExportHostAgentScanResultCsvDetails. + Date and time before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started_before of this ExportHostAgentScanResultCsvDetails. + :rtype: datetime + """ + return self._time_started_before + + @time_started_before.setter + def time_started_before(self, time_started_before): + """ + Sets the time_started_before of this ExportHostAgentScanResultCsvDetails. + Date and time before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started_before: The time_started_before of this ExportHostAgentScanResultCsvDetails. + :type: datetime + """ + self._time_started_before = time_started_before + + @property + def highest_problem_severity(self): + """ + Gets the highest_problem_severity of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by highestProblemSeverity for scan results + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + + :return: The highest_problem_severity of this ExportHostAgentScanResultCsvDetails. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by highestProblemSeverity for scan results + + + :param highest_problem_severity: The highest_problem_severity of this ExportHostAgentScanResultCsvDetails. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + raise ValueError( + "Invalid value for `highest_problem_severity`, must be None or one of {0}" + .format(allowed_values) + ) + self._highest_problem_severity = highest_problem_severity + + @property + def instance_id(self): + """ + Gets the instance_id of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by a single compute instance ID for scan results + + + :return: The instance_id of this ExportHostAgentScanResultCsvDetails. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by a single compute instance ID for scan results + + + :param instance_id: The instance_id of this ExportHostAgentScanResultCsvDetails. + :type: str + """ + self._instance_id = instance_id + + @property + def operating_system(self): + """ + Gets the operating_system of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by operating system for scan results + + + :return: The operating_system of this ExportHostAgentScanResultCsvDetails. + :rtype: str + """ + return self._operating_system + + @operating_system.setter + def operating_system(self, operating_system): + """ + Sets the operating_system of this ExportHostAgentScanResultCsvDetails. + Parameter to filter by operating system for scan results + + + :param operating_system: The operating_system of this ExportHostAgentScanResultCsvDetails. + :type: str + """ + self._operating_system = operating_system + + 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/vulnerability_scanning/models/export_host_vulnerability_csv_details.py b/src/oci/vulnerability_scanning/models/export_host_vulnerability_csv_details.py new file mode 100644 index 0000000000..7ec24347c1 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/export_host_vulnerability_csv_details.py @@ -0,0 +1,144 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ExportHostVulnerabilityCsvDetails(object): + """ + Details for a Host Vulnerability list export to CSV action + """ + + def __init__(self, **kwargs): + """ + Initializes a new ExportHostVulnerabilityCsvDetails 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 ExportHostVulnerabilityCsvDetails. + :type compartment_id: str + + :param time_last_detected_greater_than_or_equal_to: + The value to assign to the time_last_detected_greater_than_or_equal_to property of this ExportHostVulnerabilityCsvDetails. + :type time_last_detected_greater_than_or_equal_to: datetime + + :param time_last_detected_less_than_or_equal_to: + The value to assign to the time_last_detected_less_than_or_equal_to property of this ExportHostVulnerabilityCsvDetails. + :type time_last_detected_less_than_or_equal_to: datetime + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'time_last_detected_greater_than_or_equal_to': 'datetime', + 'time_last_detected_less_than_or_equal_to': 'datetime' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'time_last_detected_greater_than_or_equal_to': 'timeLastDetectedGreaterThanOrEqualTo', + 'time_last_detected_less_than_or_equal_to': 'timeLastDetectedLessThanOrEqualTo' + } + + self._compartment_id = None + self._time_last_detected_greater_than_or_equal_to = None + self._time_last_detected_less_than_or_equal_to = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ExportHostVulnerabilityCsvDetails. + The `OCID`__ of the compartment to list vulnerabilities in. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ExportHostVulnerabilityCsvDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ExportHostVulnerabilityCsvDetails. + The `OCID`__ of the compartment to list vulnerabilities in. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ExportHostVulnerabilityCsvDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_last_detected_greater_than_or_equal_to(self): + """ + **[Required]** Gets the time_last_detected_greater_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + Date and time on or after which this vulnerability was last detected, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_last_detected_greater_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + :rtype: datetime + """ + return self._time_last_detected_greater_than_or_equal_to + + @time_last_detected_greater_than_or_equal_to.setter + def time_last_detected_greater_than_or_equal_to(self, time_last_detected_greater_than_or_equal_to): + """ + Sets the time_last_detected_greater_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + Date and time on or after which this vulnerability was last detected, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_last_detected_greater_than_or_equal_to: The time_last_detected_greater_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + :type: datetime + """ + self._time_last_detected_greater_than_or_equal_to = time_last_detected_greater_than_or_equal_to + + @property + def time_last_detected_less_than_or_equal_to(self): + """ + **[Required]** Gets the time_last_detected_less_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + Date and time on or before which this vulnerability was last detected, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_last_detected_less_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + :rtype: datetime + """ + return self._time_last_detected_less_than_or_equal_to + + @time_last_detected_less_than_or_equal_to.setter + def time_last_detected_less_than_or_equal_to(self, time_last_detected_less_than_or_equal_to): + """ + Sets the time_last_detected_less_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + Date and time on or before which this vulnerability was last detected, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_last_detected_less_than_or_equal_to: The time_last_detected_less_than_or_equal_to of this ExportHostVulnerabilityCsvDetails. + :type: datetime + """ + self._time_last_detected_less_than_or_equal_to = time_last_detected_less_than_or_equal_to + + 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/vulnerability_scanning/models/host_agent_scan_result.py b/src/oci/vulnerability_scanning/models/host_agent_scan_result.py new file mode 100644 index 0000000000..a0f30e7913 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_agent_scan_result.py @@ -0,0 +1,448 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostAgentScanResult(object): + """ + A scan result for a host agent scan + """ + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResult. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResult. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResult. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResult. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResult. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResult. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostAgentScanResult 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 HostAgentScanResult. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostAgentScanResult. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostAgentScanResult. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostAgentScanResult. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this HostAgentScanResult. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param operating_system: + The value to assign to the operating_system property of this HostAgentScanResult. + :type operating_system: str + + :param problem_count: + The value to assign to the problem_count property of this HostAgentScanResult. + :type problem_count: int + + :param time_started: + The value to assign to the time_started property of this HostAgentScanResult. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostAgentScanResult. + :type time_finished: datetime + + :param problems: + The value to assign to the problems property of this HostAgentScanResult. + :type problems: list[oci.vulnerability_scanning.models.HostAgentScanResultProblem] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostAgentScanResult. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'operating_system': 'str', + 'problem_count': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'problems': 'list[HostAgentScanResultProblem]', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'operating_system': 'operatingSystem', + 'problem_count': 'problemCount', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'problems': 'problems', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._highest_problem_severity = None + self._operating_system = None + self._problem_count = None + self._time_started = None + self._time_finished = None + self._problems = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostAgentScanResult. + Unique identifier of the scan + + + :return: The id of this HostAgentScanResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostAgentScanResult. + Unique identifier of the scan + + + :param id: The id of this HostAgentScanResult. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostAgentScanResult. + Name of the resource + + + :return: The display_name of this HostAgentScanResult. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostAgentScanResult. + Name of the resource + + + :param display_name: The display_name of this HostAgentScanResult. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostAgentScanResult. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostAgentScanResult. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostAgentScanResult. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostAgentScanResult. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostAgentScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostAgentScanResult. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostAgentScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostAgentScanResult. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this HostAgentScanResult. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this HostAgentScanResult. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this HostAgentScanResult. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this HostAgentScanResult. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def operating_system(self): + """ + **[Required]** Gets the operating_system of this HostAgentScanResult. + Operating system of the host + + + :return: The operating_system of this HostAgentScanResult. + :rtype: str + """ + return self._operating_system + + @operating_system.setter + def operating_system(self, operating_system): + """ + Sets the operating_system of this HostAgentScanResult. + Operating system of the host + + + :param operating_system: The operating_system of this HostAgentScanResult. + :type: str + """ + self._operating_system = operating_system + + @property + def problem_count(self): + """ + Gets the problem_count of this HostAgentScanResult. + Total number of problems found in this scan + + + :return: The problem_count of this HostAgentScanResult. + :rtype: int + """ + return self._problem_count + + @problem_count.setter + def problem_count(self, problem_count): + """ + Sets the problem_count of this HostAgentScanResult. + Total number of problems found in this scan + + + :param problem_count: The problem_count of this HostAgentScanResult. + :type: int + """ + self._problem_count = problem_count + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostAgentScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostAgentScanResult. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostAgentScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostAgentScanResult. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostAgentScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostAgentScanResult. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostAgentScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostAgentScanResult. + :type: datetime + """ + self._time_finished = time_finished + + @property + def problems(self): + """ + **[Required]** Gets the problems of this HostAgentScanResult. + List of problems found in this scan + + + :return: The problems of this HostAgentScanResult. + :rtype: list[oci.vulnerability_scanning.models.HostAgentScanResultProblem] + """ + return self._problems + + @problems.setter + def problems(self, problems): + """ + Sets the problems of this HostAgentScanResult. + List of problems found in this scan + + + :param problems: The problems of this HostAgentScanResult. + :type: list[oci.vulnerability_scanning.models.HostAgentScanResultProblem] + """ + self._problems = problems + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostAgentScanResult. + The current state of the result. + + 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 HostAgentScanResult. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostAgentScanResult. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostAgentScanResult. + :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 + + 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/vulnerability_scanning/models/host_agent_scan_result_problem.py b/src/oci/vulnerability_scanning/models/host_agent_scan_result_problem.py new file mode 100644 index 0000000000..56750e4669 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_agent_scan_result_problem.py @@ -0,0 +1,335 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostAgentScanResultProblem(object): + """ + A problem found in a host agent scan + """ + + #: A constant which can be used with the severity property of a HostAgentScanResultProblem. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a HostAgentScanResultProblem. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a HostAgentScanResultProblem. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a HostAgentScanResultProblem. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a HostAgentScanResultProblem. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the state property of a HostAgentScanResultProblem. + #: This constant has a value of "OPEN" + STATE_OPEN = "OPEN" + + #: A constant which can be used with the state property of a HostAgentScanResultProblem. + #: This constant has a value of "FIXED" + STATE_FIXED = "FIXED" + + #: A constant which can be used with the state property of a HostAgentScanResultProblem. + #: This constant has a value of "NOT_APPLICABLE" + STATE_NOT_APPLICABLE = "NOT_APPLICABLE" + + def __init__(self, **kwargs): + """ + Initializes a new HostAgentScanResultProblem 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 HostAgentScanResultProblem. + :type name: str + + :param description: + The value to assign to the description property of this HostAgentScanResultProblem. + :type description: str + + :param severity: + The value to assign to the severity property of this HostAgentScanResultProblem. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param state: + The value to assign to the state property of this HostAgentScanResultProblem. + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param cve_reference: + The value to assign to the cve_reference property of this HostAgentScanResultProblem. + :type cve_reference: str + + :param issue_id: + The value to assign to the issue_id property of this HostAgentScanResultProblem. + :type issue_id: int + + :param time_first_detected: + The value to assign to the time_first_detected property of this HostAgentScanResultProblem. + :type time_first_detected: datetime + + :param time_last_detected: + The value to assign to the time_last_detected property of this HostAgentScanResultProblem. + :type time_last_detected: datetime + + """ + self.swagger_types = { + 'name': 'str', + 'description': 'str', + 'severity': 'str', + 'state': 'str', + 'cve_reference': 'str', + 'issue_id': 'int', + 'time_first_detected': 'datetime', + 'time_last_detected': 'datetime' + } + + self.attribute_map = { + 'name': 'name', + 'description': 'description', + 'severity': 'severity', + 'state': 'state', + 'cve_reference': 'cveReference', + 'issue_id': 'issueId', + 'time_first_detected': 'timeFirstDetected', + 'time_last_detected': 'timeLastDetected' + } + + self._name = None + self._description = None + self._severity = None + self._state = None + self._cve_reference = None + self._issue_id = None + self._time_first_detected = None + self._time_last_detected = None + + @property + def name(self): + """ + **[Required]** Gets the name of this HostAgentScanResultProblem. + Name of the problem + + + :return: The name of this HostAgentScanResultProblem. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HostAgentScanResultProblem. + Name of the problem + + + :param name: The name of this HostAgentScanResultProblem. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this HostAgentScanResultProblem. + Problem description + + + :return: The description of this HostAgentScanResultProblem. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this HostAgentScanResultProblem. + Problem description + + + :param description: The description of this HostAgentScanResultProblem. + :type: str + """ + self._description = description + + @property + def severity(self): + """ + **[Required]** Gets the severity of this HostAgentScanResultProblem. + Problem severity + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this HostAgentScanResultProblem. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this HostAgentScanResultProblem. + Problem severity + + + :param severity: The severity of this HostAgentScanResultProblem. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def state(self): + """ + Gets the state of this HostAgentScanResultProblem. + State of the vulnerability + + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this HostAgentScanResultProblem. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this HostAgentScanResultProblem. + State of the vulnerability + + + :param state: The state of this HostAgentScanResultProblem. + :type: str + """ + allowed_values = ["OPEN", "FIXED", "NOT_APPLICABLE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = state + + @property + def cve_reference(self): + """ + Gets the cve_reference of this HostAgentScanResultProblem. + Reference to problem MITRE CVE ID + + + :return: The cve_reference of this HostAgentScanResultProblem. + :rtype: str + """ + return self._cve_reference + + @cve_reference.setter + def cve_reference(self, cve_reference): + """ + Sets the cve_reference of this HostAgentScanResultProblem. + Reference to problem MITRE CVE ID + + + :param cve_reference: The cve_reference of this HostAgentScanResultProblem. + :type: str + """ + self._cve_reference = cve_reference + + @property + def issue_id(self): + """ + Gets the issue_id of this HostAgentScanResultProblem. + Reference to problem issue ID + + + :return: The issue_id of this HostAgentScanResultProblem. + :rtype: int + """ + return self._issue_id + + @issue_id.setter + def issue_id(self, issue_id): + """ + Sets the issue_id of this HostAgentScanResultProblem. + Reference to problem issue ID + + + :param issue_id: The issue_id of this HostAgentScanResultProblem. + :type: int + """ + self._issue_id = issue_id + + @property + def time_first_detected(self): + """ + Gets the time_first_detected of this HostAgentScanResultProblem. + Date of scan result that first reported the vulnerability + + + :return: The time_first_detected of this HostAgentScanResultProblem. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this HostAgentScanResultProblem. + Date of scan result that first reported the vulnerability + + + :param time_first_detected: The time_first_detected of this HostAgentScanResultProblem. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def time_last_detected(self): + """ + Gets the time_last_detected of this HostAgentScanResultProblem. + Date of scan result that most recently reported the vulnerability + + + :return: The time_last_detected of this HostAgentScanResultProblem. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this HostAgentScanResultProblem. + Date of scan result that most recently reported the vulnerability + + + :param time_last_detected: The time_last_detected of this HostAgentScanResultProblem. + :type: datetime + """ + self._time_last_detected = time_last_detected + + 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/vulnerability_scanning/models/host_agent_scan_result_summary.py b/src/oci/vulnerability_scanning/models/host_agent_scan_result_summary.py new file mode 100644 index 0000000000..8d1010a9b2 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_agent_scan_result_summary.py @@ -0,0 +1,417 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostAgentScanResultSummary(object): + """ + A summary of a result for a host agent scan + """ + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResultSummary. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResultSummary. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResultSummary. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResultSummary. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a HostAgentScanResultSummary. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostAgentScanResultSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostAgentScanResultSummary 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 HostAgentScanResultSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostAgentScanResultSummary. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostAgentScanResultSummary. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostAgentScanResultSummary. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this HostAgentScanResultSummary. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param operating_system: + The value to assign to the operating_system property of this HostAgentScanResultSummary. + :type operating_system: str + + :param problem_count: + The value to assign to the problem_count property of this HostAgentScanResultSummary. + :type problem_count: int + + :param time_started: + The value to assign to the time_started property of this HostAgentScanResultSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostAgentScanResultSummary. + :type time_finished: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostAgentScanResultSummary. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'operating_system': 'str', + 'problem_count': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'operating_system': 'operatingSystem', + 'problem_count': 'problemCount', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._highest_problem_severity = None + self._operating_system = None + self._problem_count = None + self._time_started = None + self._time_finished = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostAgentScanResultSummary. + Unique identifier of the scan + + + :return: The id of this HostAgentScanResultSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostAgentScanResultSummary. + Unique identifier of the scan + + + :param id: The id of this HostAgentScanResultSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostAgentScanResultSummary. + Name of the resource + + + :return: The display_name of this HostAgentScanResultSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostAgentScanResultSummary. + Name of the resource + + + :param display_name: The display_name of this HostAgentScanResultSummary. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostAgentScanResultSummary. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostAgentScanResultSummary. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostAgentScanResultSummary. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostAgentScanResultSummary. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostAgentScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostAgentScanResultSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostAgentScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostAgentScanResultSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this HostAgentScanResultSummary. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this HostAgentScanResultSummary. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this HostAgentScanResultSummary. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this HostAgentScanResultSummary. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def operating_system(self): + """ + **[Required]** Gets the operating_system of this HostAgentScanResultSummary. + Operating system of the host + + + :return: The operating_system of this HostAgentScanResultSummary. + :rtype: str + """ + return self._operating_system + + @operating_system.setter + def operating_system(self, operating_system): + """ + Sets the operating_system of this HostAgentScanResultSummary. + Operating system of the host + + + :param operating_system: The operating_system of this HostAgentScanResultSummary. + :type: str + """ + self._operating_system = operating_system + + @property + def problem_count(self): + """ + **[Required]** Gets the problem_count of this HostAgentScanResultSummary. + Total number of problems found in this scan + + + :return: The problem_count of this HostAgentScanResultSummary. + :rtype: int + """ + return self._problem_count + + @problem_count.setter + def problem_count(self, problem_count): + """ + Sets the problem_count of this HostAgentScanResultSummary. + Total number of problems found in this scan + + + :param problem_count: The problem_count of this HostAgentScanResultSummary. + :type: int + """ + self._problem_count = problem_count + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostAgentScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostAgentScanResultSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostAgentScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostAgentScanResultSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostAgentScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostAgentScanResultSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostAgentScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostAgentScanResultSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostAgentScanResultSummary. + The current state of the result. + + 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 HostAgentScanResultSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostAgentScanResultSummary. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostAgentScanResultSummary. + :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 + + 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/vulnerability_scanning/models/host_agent_scan_result_summary_collection.py b/src/oci/vulnerability_scanning/models/host_agent_scan_result_summary_collection.py new file mode 100644 index 0000000000..c16ffcb8eb --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_agent_scan_result_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostAgentScanResultSummaryCollection(object): + """ + A collection of HostAgentScanResultSummary + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostAgentScanResultSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostAgentScanResultSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostAgentScanResultSummary] + + """ + self.swagger_types = { + 'items': 'list[HostAgentScanResultSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostAgentScanResultSummaryCollection. + The HostAgentScanResultSummary objects in the collection + + + :return: The items of this HostAgentScanResultSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostAgentScanResultSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostAgentScanResultSummaryCollection. + The HostAgentScanResultSummary objects in the collection + + + :param items: The items of this HostAgentScanResultSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostAgentScanResultSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_cis_benchmark_scan_result.py b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result.py new file mode 100644 index 0000000000..fa95dad5b8 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result.py @@ -0,0 +1,358 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostCisBenchmarkScanResult(object): + """ + A scan result of all CIS (Center for Internet Security) benchmark execution for this host + """ + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResult. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostCisBenchmarkScanResult 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 HostCisBenchmarkScanResult. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostCisBenchmarkScanResult. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostCisBenchmarkScanResult. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostCisBenchmarkScanResult. + :type compartment_id: str + + :param time_started: + The value to assign to the time_started property of this HostCisBenchmarkScanResult. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostCisBenchmarkScanResult. + :type time_finished: datetime + + :param cis_benchmark_scan_issues_count: + The value to assign to the cis_benchmark_scan_issues_count property of this HostCisBenchmarkScanResult. + :type cis_benchmark_scan_issues_count: int + + :param cis_benchmark_scan_result_scores: + The value to assign to the cis_benchmark_scan_result_scores property of this HostCisBenchmarkScanResult. + :type cis_benchmark_scan_result_scores: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostCisBenchmarkScanResult. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'cis_benchmark_scan_issues_count': 'int', + 'cis_benchmark_scan_result_scores': 'list[HostCisBenchmarkScanResultScore]', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'cis_benchmark_scan_issues_count': 'cisBenchmarkScanIssuesCount', + 'cis_benchmark_scan_result_scores': 'cisBenchmarkScanResultScores', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._time_started = None + self._time_finished = None + self._cis_benchmark_scan_issues_count = None + self._cis_benchmark_scan_result_scores = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostCisBenchmarkScanResult. + Unique identifier of the scan + + + :return: The id of this HostCisBenchmarkScanResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostCisBenchmarkScanResult. + Unique identifier of the scan + + + :param id: The id of this HostCisBenchmarkScanResult. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostCisBenchmarkScanResult. + Name of the result + + + :return: The display_name of this HostCisBenchmarkScanResult. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostCisBenchmarkScanResult. + Name of the result + + + :param display_name: The display_name of this HostCisBenchmarkScanResult. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostCisBenchmarkScanResult. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostCisBenchmarkScanResult. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostCisBenchmarkScanResult. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostCisBenchmarkScanResult. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostCisBenchmarkScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostCisBenchmarkScanResult. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostCisBenchmarkScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostCisBenchmarkScanResult. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostCisBenchmarkScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostCisBenchmarkScanResult. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostCisBenchmarkScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostCisBenchmarkScanResult. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostCisBenchmarkScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostCisBenchmarkScanResult. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostCisBenchmarkScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostCisBenchmarkScanResult. + :type: datetime + """ + self._time_finished = time_finished + + @property + def cis_benchmark_scan_issues_count(self): + """ + **[Required]** Gets the cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResult. + Total number of CIS (Center for Internet Security) benchmark issues found in this scan + + + :return: The cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResult. + :rtype: int + """ + return self._cis_benchmark_scan_issues_count + + @cis_benchmark_scan_issues_count.setter + def cis_benchmark_scan_issues_count(self, cis_benchmark_scan_issues_count): + """ + Sets the cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResult. + Total number of CIS (Center for Internet Security) benchmark issues found in this scan + + + :param cis_benchmark_scan_issues_count: The cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResult. + :type: int + """ + self._cis_benchmark_scan_issues_count = cis_benchmark_scan_issues_count + + @property + def cis_benchmark_scan_result_scores(self): + """ + **[Required]** Gets the cis_benchmark_scan_result_scores of this HostCisBenchmarkScanResult. + A single CIS (Center for Internet Security) benchmark scan executed on a host. + + + :return: The cis_benchmark_scan_result_scores of this HostCisBenchmarkScanResult. + :rtype: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore] + """ + return self._cis_benchmark_scan_result_scores + + @cis_benchmark_scan_result_scores.setter + def cis_benchmark_scan_result_scores(self, cis_benchmark_scan_result_scores): + """ + Sets the cis_benchmark_scan_result_scores of this HostCisBenchmarkScanResult. + A single CIS (Center for Internet Security) benchmark scan executed on a host. + + + :param cis_benchmark_scan_result_scores: The cis_benchmark_scan_result_scores of this HostCisBenchmarkScanResult. + :type: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultScore] + """ + self._cis_benchmark_scan_result_scores = cis_benchmark_scan_result_scores + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostCisBenchmarkScanResult. + The current state of the result. + + 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 HostCisBenchmarkScanResult. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostCisBenchmarkScanResult. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostCisBenchmarkScanResult. + :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 + + 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/vulnerability_scanning/models/host_cis_benchmark_scan_result_score.py b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_score.py new file mode 100644 index 0000000000..a502dba357 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_score.py @@ -0,0 +1,148 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostCisBenchmarkScanResultScore(object): + """ + A single CIS (Center for Internet Security) benchmark executed in a host scan + """ + + #: A constant which can be used with the score property of a HostCisBenchmarkScanResultScore. + #: This constant has a value of "PASS" + SCORE_PASS = "PASS" + + #: A constant which can be used with the score property of a HostCisBenchmarkScanResultScore. + #: This constant has a value of "FAIL" + SCORE_FAIL = "FAIL" + + def __init__(self, **kwargs): + """ + Initializes a new HostCisBenchmarkScanResultScore object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param benchmark_identifier: + The value to assign to the benchmark_identifier property of this HostCisBenchmarkScanResultScore. + :type benchmark_identifier: str + + :param description: + The value to assign to the description property of this HostCisBenchmarkScanResultScore. + :type description: str + + :param score: + The value to assign to the score property of this HostCisBenchmarkScanResultScore. + Allowed values for this property are: "PASS", "FAIL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type score: str + + """ + self.swagger_types = { + 'benchmark_identifier': 'str', + 'description': 'str', + 'score': 'str' + } + + self.attribute_map = { + 'benchmark_identifier': 'benchmarkIdentifier', + 'description': 'description', + 'score': 'score' + } + + self._benchmark_identifier = None + self._description = None + self._score = None + + @property + def benchmark_identifier(self): + """ + **[Required]** Gets the benchmark_identifier of this HostCisBenchmarkScanResultScore. + Identifier for this CIS (Center for Internet Security) benchmark + + + :return: The benchmark_identifier of this HostCisBenchmarkScanResultScore. + :rtype: str + """ + return self._benchmark_identifier + + @benchmark_identifier.setter + def benchmark_identifier(self, benchmark_identifier): + """ + Sets the benchmark_identifier of this HostCisBenchmarkScanResultScore. + Identifier for this CIS (Center for Internet Security) benchmark + + + :param benchmark_identifier: The benchmark_identifier of this HostCisBenchmarkScanResultScore. + :type: str + """ + self._benchmark_identifier = benchmark_identifier + + @property + def description(self): + """ + **[Required]** Gets the description of this HostCisBenchmarkScanResultScore. + Details about what this CIS (Center for Internet Security) benchmark represents + + + :return: The description of this HostCisBenchmarkScanResultScore. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this HostCisBenchmarkScanResultScore. + Details about what this CIS (Center for Internet Security) benchmark represents + + + :param description: The description of this HostCisBenchmarkScanResultScore. + :type: str + """ + self._description = description + + @property + def score(self): + """ + **[Required]** Gets the score of this HostCisBenchmarkScanResultScore. + Result score of CIS (Center for Internet Security) benchmark execution (Pass/Fail) + + Allowed values for this property are: "PASS", "FAIL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The score of this HostCisBenchmarkScanResultScore. + :rtype: str + """ + return self._score + + @score.setter + def score(self, score): + """ + Sets the score of this HostCisBenchmarkScanResultScore. + Result score of CIS (Center for Internet Security) benchmark execution (Pass/Fail) + + + :param score: The score of this HostCisBenchmarkScanResultScore. + :type: str + """ + allowed_values = ["PASS", "FAIL"] + if not value_allowed_none_or_none_sentinel(score, allowed_values): + score = 'UNKNOWN_ENUM_VALUE' + self._score = score + + 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/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary.py b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary.py new file mode 100644 index 0000000000..bf007e7b6b --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary.py @@ -0,0 +1,327 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostCisBenchmarkScanResultSummary(object): + """ + A summary of a result for all CIS (Center for Internet Security) benchmark execution for this host + """ + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostCisBenchmarkScanResultSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostCisBenchmarkScanResultSummary 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 HostCisBenchmarkScanResultSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostCisBenchmarkScanResultSummary. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostCisBenchmarkScanResultSummary. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostCisBenchmarkScanResultSummary. + :type compartment_id: str + + :param time_started: + The value to assign to the time_started property of this HostCisBenchmarkScanResultSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostCisBenchmarkScanResultSummary. + :type time_finished: datetime + + :param cis_benchmark_scan_issues_count: + The value to assign to the cis_benchmark_scan_issues_count property of this HostCisBenchmarkScanResultSummary. + :type cis_benchmark_scan_issues_count: int + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostCisBenchmarkScanResultSummary. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'cis_benchmark_scan_issues_count': 'int', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'cis_benchmark_scan_issues_count': 'cisBenchmarkScanIssuesCount', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._time_started = None + self._time_finished = None + self._cis_benchmark_scan_issues_count = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostCisBenchmarkScanResultSummary. + Unique identifier of the scan + + + :return: The id of this HostCisBenchmarkScanResultSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostCisBenchmarkScanResultSummary. + Unique identifier of the scan + + + :param id: The id of this HostCisBenchmarkScanResultSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostCisBenchmarkScanResultSummary. + Name of the resource + + + :return: The display_name of this HostCisBenchmarkScanResultSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostCisBenchmarkScanResultSummary. + Name of the resource + + + :param display_name: The display_name of this HostCisBenchmarkScanResultSummary. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostCisBenchmarkScanResultSummary. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostCisBenchmarkScanResultSummary. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostCisBenchmarkScanResultSummary. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostCisBenchmarkScanResultSummary. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostCisBenchmarkScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostCisBenchmarkScanResultSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostCisBenchmarkScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostCisBenchmarkScanResultSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostCisBenchmarkScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostCisBenchmarkScanResultSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostCisBenchmarkScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostCisBenchmarkScanResultSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostCisBenchmarkScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostCisBenchmarkScanResultSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostCisBenchmarkScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostCisBenchmarkScanResultSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def cis_benchmark_scan_issues_count(self): + """ + **[Required]** Gets the cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResultSummary. + Total number of CIS (Center for Internet Security) benchmark issues found in this scan + + + :return: The cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResultSummary. + :rtype: int + """ + return self._cis_benchmark_scan_issues_count + + @cis_benchmark_scan_issues_count.setter + def cis_benchmark_scan_issues_count(self, cis_benchmark_scan_issues_count): + """ + Sets the cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResultSummary. + Total number of CIS (Center for Internet Security) benchmark issues found in this scan + + + :param cis_benchmark_scan_issues_count: The cis_benchmark_scan_issues_count of this HostCisBenchmarkScanResultSummary. + :type: int + """ + self._cis_benchmark_scan_issues_count = cis_benchmark_scan_issues_count + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostCisBenchmarkScanResultSummary. + The current state of the result. + + 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 HostCisBenchmarkScanResultSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostCisBenchmarkScanResultSummary. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostCisBenchmarkScanResultSummary. + :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 + + 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/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary_collection.py b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary_collection.py new file mode 100644 index 0000000000..c3ef634d4e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_cis_benchmark_scan_result_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostCisBenchmarkScanResultSummaryCollection(object): + """ + A collection of multiple Host CIS (Center for Internet Security) Benchmark Scan Result Summary + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostCisBenchmarkScanResultSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostCisBenchmarkScanResultSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary] + + """ + self.swagger_types = { + 'items': 'list[HostCisBenchmarkScanResultSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostCisBenchmarkScanResultSummaryCollection. + The HostCisBenchmarkScanResultSummary objects in the collection + + + :return: The items of this HostCisBenchmarkScanResultSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostCisBenchmarkScanResultSummaryCollection. + The HostCisBenchmarkScanResultSummary objects in the collection + + + :param items: The items of this HostCisBenchmarkScanResultSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostCisBenchmarkScanResultSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_cis_benchmark_settings.py b/src/oci/vulnerability_scanning/models/host_cis_benchmark_settings.py new file mode 100644 index 0000000000..7d20bdc610 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_cis_benchmark_settings.py @@ -0,0 +1,94 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostCisBenchmarkSettings(object): + """ + CIS (Center for Internet Security) Benchmark scan settings for a host scan + """ + + #: A constant which can be used with the scan_level property of a HostCisBenchmarkSettings. + #: This constant has a value of "NONE" + SCAN_LEVEL_NONE = "NONE" + + #: A constant which can be used with the scan_level property of a HostCisBenchmarkSettings. + #: This constant has a value of "LIGHT" + SCAN_LEVEL_LIGHT = "LIGHT" + + #: A constant which can be used with the scan_level property of a HostCisBenchmarkSettings. + #: This constant has a value of "MEDIUM" + SCAN_LEVEL_MEDIUM = "MEDIUM" + + #: A constant which can be used with the scan_level property of a HostCisBenchmarkSettings. + #: This constant has a value of "STRICT" + SCAN_LEVEL_STRICT = "STRICT" + + def __init__(self, **kwargs): + """ + Initializes a new HostCisBenchmarkSettings object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param scan_level: + The value to assign to the scan_level property of this HostCisBenchmarkSettings. + Allowed values for this property are: "NONE", "LIGHT", "MEDIUM", "STRICT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type scan_level: str + + """ + self.swagger_types = { + 'scan_level': 'str' + } + + self.attribute_map = { + 'scan_level': 'scanLevel' + } + + self._scan_level = None + + @property + def scan_level(self): + """ + Gets the scan_level of this HostCisBenchmarkSettings. + The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely. + + Allowed values for this property are: "NONE", "LIGHT", "MEDIUM", "STRICT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The scan_level of this HostCisBenchmarkSettings. + :rtype: str + """ + return self._scan_level + + @scan_level.setter + def scan_level(self, scan_level): + """ + Sets the scan_level of this HostCisBenchmarkSettings. + The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely. + + + :param scan_level: The scan_level of this HostCisBenchmarkSettings. + :type: str + """ + allowed_values = ["NONE", "LIGHT", "MEDIUM", "STRICT"] + if not value_allowed_none_or_none_sentinel(scan_level, allowed_values): + scan_level = 'UNKNOWN_ENUM_VALUE' + self._scan_level = scan_level + + 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/vulnerability_scanning/models/host_endpoint_protection_scan_result.py b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result.py new file mode 100644 index 0000000000..a07e2e7fa7 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result.py @@ -0,0 +1,417 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostEndpointProtectionScanResult(object): + """ + A scan result for a host endpoint protection scan + """ + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResult. + #: This constant has a value of "NONE" + PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResult. + #: This constant has a value of "LOW" + PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResult. + #: This constant has a value of "MEDIUM" + PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResult. + #: This constant has a value of "HIGH" + PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResult. + #: This constant has a value of "CRITICAL" + PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResult. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostEndpointProtectionScanResult 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 HostEndpointProtectionScanResult. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostEndpointProtectionScanResult. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostEndpointProtectionScanResult. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostEndpointProtectionScanResult. + :type compartment_id: str + + :param time_started: + The value to assign to the time_started property of this HostEndpointProtectionScanResult. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostEndpointProtectionScanResult. + :type time_finished: datetime + + :param problem_severity: + The value to assign to the problem_severity property of this HostEndpointProtectionScanResult. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type problem_severity: str + + :param endpoint_protections_count: + The value to assign to the endpoint_protections_count property of this HostEndpointProtectionScanResult. + :type endpoint_protections_count: int + + :param endpoint_protections: + The value to assign to the endpoint_protections property of this HostEndpointProtectionScanResult. + :type endpoint_protections: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostEndpointProtectionScanResult. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'problem_severity': 'str', + 'endpoint_protections_count': 'int', + 'endpoint_protections': 'list[HostEndpointProtectionScanResultEndpointProtection]', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'problem_severity': 'problemSeverity', + 'endpoint_protections_count': 'endpointProtectionsCount', + 'endpoint_protections': 'endpointProtections', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._time_started = None + self._time_finished = None + self._problem_severity = None + self._endpoint_protections_count = None + self._endpoint_protections = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostEndpointProtectionScanResult. + Unique identifier of the scan + + + :return: The id of this HostEndpointProtectionScanResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostEndpointProtectionScanResult. + Unique identifier of the scan + + + :param id: The id of this HostEndpointProtectionScanResult. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostEndpointProtectionScanResult. + Name of the resource + + + :return: The display_name of this HostEndpointProtectionScanResult. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostEndpointProtectionScanResult. + Name of the resource + + + :param display_name: The display_name of this HostEndpointProtectionScanResult. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostEndpointProtectionScanResult. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostEndpointProtectionScanResult. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostEndpointProtectionScanResult. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostEndpointProtectionScanResult. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostEndpointProtectionScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostEndpointProtectionScanResult. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostEndpointProtectionScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostEndpointProtectionScanResult. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostEndpointProtectionScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostEndpointProtectionScanResult. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostEndpointProtectionScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostEndpointProtectionScanResult. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostEndpointProtectionScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostEndpointProtectionScanResult. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostEndpointProtectionScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostEndpointProtectionScanResult. + :type: datetime + """ + self._time_finished = time_finished + + @property + def problem_severity(self): + """ + **[Required]** Gets the problem_severity of this HostEndpointProtectionScanResult. + Problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The problem_severity of this HostEndpointProtectionScanResult. + :rtype: str + """ + return self._problem_severity + + @problem_severity.setter + def problem_severity(self, problem_severity): + """ + Sets the problem_severity of this HostEndpointProtectionScanResult. + Problem severity in this report + + + :param problem_severity: The problem_severity of this HostEndpointProtectionScanResult. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(problem_severity, allowed_values): + problem_severity = 'UNKNOWN_ENUM_VALUE' + self._problem_severity = problem_severity + + @property + def endpoint_protections_count(self): + """ + **[Required]** Gets the endpoint_protections_count of this HostEndpointProtectionScanResult. + Total number of endpoint protections found in this scan + + + :return: The endpoint_protections_count of this HostEndpointProtectionScanResult. + :rtype: int + """ + return self._endpoint_protections_count + + @endpoint_protections_count.setter + def endpoint_protections_count(self, endpoint_protections_count): + """ + Sets the endpoint_protections_count of this HostEndpointProtectionScanResult. + Total number of endpoint protections found in this scan + + + :param endpoint_protections_count: The endpoint_protections_count of this HostEndpointProtectionScanResult. + :type: int + """ + self._endpoint_protections_count = endpoint_protections_count + + @property + def endpoint_protections(self): + """ + **[Required]** Gets the endpoint_protections of this HostEndpointProtectionScanResult. + List of endpoint protections found in this scan + + + :return: The endpoint_protections of this HostEndpointProtectionScanResult. + :rtype: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection] + """ + return self._endpoint_protections + + @endpoint_protections.setter + def endpoint_protections(self, endpoint_protections): + """ + Sets the endpoint_protections of this HostEndpointProtectionScanResult. + List of endpoint protections found in this scan + + + :param endpoint_protections: The endpoint_protections of this HostEndpointProtectionScanResult. + :type: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultEndpointProtection] + """ + self._endpoint_protections = endpoint_protections + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostEndpointProtectionScanResult. + The current state of the result. + + 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 HostEndpointProtectionScanResult. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostEndpointProtectionScanResult. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostEndpointProtectionScanResult. + :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 + + 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/vulnerability_scanning/models/host_endpoint_protection_scan_result_endpoint_protection.py b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_endpoint_protection.py new file mode 100644 index 0000000000..4ed443fb06 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_endpoint_protection.py @@ -0,0 +1,195 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostEndpointProtectionScanResultEndpointProtection(object): + """ + An endpoint protection found in a host scan + """ + + #: A constant which can be used with the severity property of a HostEndpointProtectionScanResultEndpointProtection. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a HostEndpointProtectionScanResultEndpointProtection. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a HostEndpointProtectionScanResultEndpointProtection. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a HostEndpointProtectionScanResultEndpointProtection. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a HostEndpointProtectionScanResultEndpointProtection. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + def __init__(self, **kwargs): + """ + Initializes a new HostEndpointProtectionScanResultEndpointProtection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param service: + The value to assign to the service property of this HostEndpointProtectionScanResultEndpointProtection. + :type service: str + + :param configuration_finding: + The value to assign to the configuration_finding property of this HostEndpointProtectionScanResultEndpointProtection. + :type configuration_finding: str + + :param time_signature_updated: + The value to assign to the time_signature_updated property of this HostEndpointProtectionScanResultEndpointProtection. + :type time_signature_updated: datetime + + :param severity: + The value to assign to the severity property of this HostEndpointProtectionScanResultEndpointProtection. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + """ + self.swagger_types = { + 'service': 'str', + 'configuration_finding': 'str', + 'time_signature_updated': 'datetime', + 'severity': 'str' + } + + self.attribute_map = { + 'service': 'service', + 'configuration_finding': 'configurationFinding', + 'time_signature_updated': 'timeSignatureUpdated', + 'severity': 'severity' + } + + self._service = None + self._configuration_finding = None + self._time_signature_updated = None + self._severity = None + + @property + def service(self): + """ + **[Required]** Gets the service of this HostEndpointProtectionScanResultEndpointProtection. + Name of endpoint protection service + + + :return: The service of this HostEndpointProtectionScanResultEndpointProtection. + :rtype: str + """ + return self._service + + @service.setter + def service(self, service): + """ + Sets the service of this HostEndpointProtectionScanResultEndpointProtection. + Name of endpoint protection service + + + :param service: The service of this HostEndpointProtectionScanResultEndpointProtection. + :type: str + """ + self._service = service + + @property + def configuration_finding(self): + """ + **[Required]** Gets the configuration_finding of this HostEndpointProtectionScanResultEndpointProtection. + Configuration information for endpoint protection service at the time of scan + + + :return: The configuration_finding of this HostEndpointProtectionScanResultEndpointProtection. + :rtype: str + """ + return self._configuration_finding + + @configuration_finding.setter + def configuration_finding(self, configuration_finding): + """ + Sets the configuration_finding of this HostEndpointProtectionScanResultEndpointProtection. + Configuration information for endpoint protection service at the time of scan + + + :param configuration_finding: The configuration_finding of this HostEndpointProtectionScanResultEndpointProtection. + :type: str + """ + self._configuration_finding = configuration_finding + + @property + def time_signature_updated(self): + """ + **[Required]** Gets the time_signature_updated of this HostEndpointProtectionScanResultEndpointProtection. + Date and time endpoint protection signature was updated, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_signature_updated of this HostEndpointProtectionScanResultEndpointProtection. + :rtype: datetime + """ + return self._time_signature_updated + + @time_signature_updated.setter + def time_signature_updated(self, time_signature_updated): + """ + Sets the time_signature_updated of this HostEndpointProtectionScanResultEndpointProtection. + Date and time endpoint protection signature was updated, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_signature_updated: The time_signature_updated of this HostEndpointProtectionScanResultEndpointProtection. + :type: datetime + """ + self._time_signature_updated = time_signature_updated + + @property + def severity(self): + """ + **[Required]** Gets the severity of this HostEndpointProtectionScanResultEndpointProtection. + Problem severity + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this HostEndpointProtectionScanResultEndpointProtection. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this HostEndpointProtectionScanResultEndpointProtection. + Problem severity + + + :param severity: The severity of this HostEndpointProtectionScanResultEndpointProtection. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + 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/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary.py b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary.py new file mode 100644 index 0000000000..5243eea1f7 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary.py @@ -0,0 +1,386 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostEndpointProtectionScanResultSummary(object): + """ + A summary of a result for endpoint protections found in a host scan + """ + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "NONE" + PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "LOW" + PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "MEDIUM" + PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "HIGH" + PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the problem_severity property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "CRITICAL" + PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostEndpointProtectionScanResultSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostEndpointProtectionScanResultSummary 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 HostEndpointProtectionScanResultSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostEndpointProtectionScanResultSummary. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostEndpointProtectionScanResultSummary. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostEndpointProtectionScanResultSummary. + :type compartment_id: str + + :param time_started: + The value to assign to the time_started property of this HostEndpointProtectionScanResultSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostEndpointProtectionScanResultSummary. + :type time_finished: datetime + + :param problem_severity: + The value to assign to the problem_severity property of this HostEndpointProtectionScanResultSummary. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type problem_severity: str + + :param endpoint_protections_count: + The value to assign to the endpoint_protections_count property of this HostEndpointProtectionScanResultSummary. + :type endpoint_protections_count: int + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostEndpointProtectionScanResultSummary. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'problem_severity': 'str', + 'endpoint_protections_count': 'int', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'problem_severity': 'problemSeverity', + 'endpoint_protections_count': 'endpointProtectionsCount', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._time_started = None + self._time_finished = None + self._problem_severity = None + self._endpoint_protections_count = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostEndpointProtectionScanResultSummary. + Unique identifier of the scan + + + :return: The id of this HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostEndpointProtectionScanResultSummary. + Unique identifier of the scan + + + :param id: The id of this HostEndpointProtectionScanResultSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostEndpointProtectionScanResultSummary. + Name of the resource + + + :return: The display_name of this HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostEndpointProtectionScanResultSummary. + Name of the resource + + + :param display_name: The display_name of this HostEndpointProtectionScanResultSummary. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostEndpointProtectionScanResultSummary. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostEndpointProtectionScanResultSummary. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostEndpointProtectionScanResultSummary. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostEndpointProtectionScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostEndpointProtectionScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostEndpointProtectionScanResultSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostEndpointProtectionScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostEndpointProtectionScanResultSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostEndpointProtectionScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostEndpointProtectionScanResultSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostEndpointProtectionScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostEndpointProtectionScanResultSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostEndpointProtectionScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostEndpointProtectionScanResultSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def problem_severity(self): + """ + **[Required]** Gets the problem_severity of this HostEndpointProtectionScanResultSummary. + Problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The problem_severity of this HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._problem_severity + + @problem_severity.setter + def problem_severity(self, problem_severity): + """ + Sets the problem_severity of this HostEndpointProtectionScanResultSummary. + Problem severity in this report + + + :param problem_severity: The problem_severity of this HostEndpointProtectionScanResultSummary. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(problem_severity, allowed_values): + problem_severity = 'UNKNOWN_ENUM_VALUE' + self._problem_severity = problem_severity + + @property + def endpoint_protections_count(self): + """ + **[Required]** Gets the endpoint_protections_count of this HostEndpointProtectionScanResultSummary. + Total number of endpoint protections found in this scan + + + :return: The endpoint_protections_count of this HostEndpointProtectionScanResultSummary. + :rtype: int + """ + return self._endpoint_protections_count + + @endpoint_protections_count.setter + def endpoint_protections_count(self, endpoint_protections_count): + """ + Sets the endpoint_protections_count of this HostEndpointProtectionScanResultSummary. + Total number of endpoint protections found in this scan + + + :param endpoint_protections_count: The endpoint_protections_count of this HostEndpointProtectionScanResultSummary. + :type: int + """ + self._endpoint_protections_count = endpoint_protections_count + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostEndpointProtectionScanResultSummary. + The current state of the result. + + 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 HostEndpointProtectionScanResultSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostEndpointProtectionScanResultSummary. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostEndpointProtectionScanResultSummary. + :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 + + 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/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary_collection.py b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary_collection.py new file mode 100644 index 0000000000..5fa7de0b3c --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_endpoint_protection_scan_result_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostEndpointProtectionScanResultSummaryCollection(object): + """ + A collection of multiple Host EndpointProtection Scan Result Summary + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostEndpointProtectionScanResultSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostEndpointProtectionScanResultSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary] + + """ + self.swagger_types = { + 'items': 'list[HostEndpointProtectionScanResultSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostEndpointProtectionScanResultSummaryCollection. + The HostEndpointProtectionScanResultSummary objects in the collection + + + :return: The items of this HostEndpointProtectionScanResultSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostEndpointProtectionScanResultSummaryCollection. + The HostEndpointProtectionScanResultSummary objects in the collection + + + :param items: The items of this HostEndpointProtectionScanResultSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostEndpointProtectionScanResultSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_endpoint_protection_settings.py b/src/oci/vulnerability_scanning/models/host_endpoint_protection_settings.py new file mode 100644 index 0000000000..82b43cbf2e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_endpoint_protection_settings.py @@ -0,0 +1,86 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostEndpointProtectionSettings(object): + """ + Endpoint Protection scan settings for a host scan + """ + + #: A constant which can be used with the scan_level property of a HostEndpointProtectionSettings. + #: This constant has a value of "NONE" + SCAN_LEVEL_NONE = "NONE" + + #: A constant which can be used with the scan_level property of a HostEndpointProtectionSettings. + #: This constant has a value of "STANDARD" + SCAN_LEVEL_STANDARD = "STANDARD" + + def __init__(self, **kwargs): + """ + Initializes a new HostEndpointProtectionSettings object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param scan_level: + The value to assign to the scan_level property of this HostEndpointProtectionSettings. + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type scan_level: str + + """ + self.swagger_types = { + 'scan_level': 'str' + } + + self.attribute_map = { + 'scan_level': 'scanLevel' + } + + self._scan_level = None + + @property + def scan_level(self): + """ + Gets the scan_level of this HostEndpointProtectionSettings. + The scan level. Use 'NONE' to disable Endpoint Protection checks entirely. + + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The scan_level of this HostEndpointProtectionSettings. + :rtype: str + """ + return self._scan_level + + @scan_level.setter + def scan_level(self, scan_level): + """ + Sets the scan_level of this HostEndpointProtectionSettings. + The scan level. Use 'NONE' to disable Endpoint Protection checks entirely. + + + :param scan_level: The scan_level of this HostEndpointProtectionSettings. + :type: str + """ + allowed_values = ["NONE", "STANDARD"] + if not value_allowed_none_or_none_sentinel(scan_level, allowed_values): + scan_level = 'UNKNOWN_ENUM_VALUE' + self._scan_level = scan_level + + 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/vulnerability_scanning/models/host_port_scan_result.py b/src/oci/vulnerability_scanning/models/host_port_scan_result.py new file mode 100644 index 0000000000..dcbc076f5f --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_port_scan_result.py @@ -0,0 +1,417 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostPortScanResult(object): + """ + A scan result for a host port scan + """ + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResult. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResult. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResult. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResult. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResult. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResult. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostPortScanResult 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 HostPortScanResult. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostPortScanResult. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostPortScanResult. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostPortScanResult. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this HostPortScanResult. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param time_started: + The value to assign to the time_started property of this HostPortScanResult. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostPortScanResult. + :type time_finished: datetime + + :param open_port_count: + The value to assign to the open_port_count property of this HostPortScanResult. + :type open_port_count: int + + :param open_ports: + The value to assign to the open_ports property of this HostPortScanResult. + :type open_ports: list[oci.vulnerability_scanning.models.HostPortScanResultOpenPort] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostPortScanResult. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'open_port_count': 'int', + 'open_ports': 'list[HostPortScanResultOpenPort]', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'open_port_count': 'openPortCount', + 'open_ports': 'openPorts', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._highest_problem_severity = None + self._time_started = None + self._time_finished = None + self._open_port_count = None + self._open_ports = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostPortScanResult. + Unique identifier of the scan + + + :return: The id of this HostPortScanResult. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostPortScanResult. + Unique identifier of the scan + + + :param id: The id of this HostPortScanResult. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostPortScanResult. + Name of the resource + + + :return: The display_name of this HostPortScanResult. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostPortScanResult. + Name of the resource + + + :param display_name: The display_name of this HostPortScanResult. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostPortScanResult. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostPortScanResult. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostPortScanResult. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostPortScanResult. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostPortScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostPortScanResult. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostPortScanResult. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostPortScanResult. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this HostPortScanResult. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this HostPortScanResult. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this HostPortScanResult. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this HostPortScanResult. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostPortScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostPortScanResult. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostPortScanResult. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostPortScanResult. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostPortScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostPortScanResult. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostPortScanResult. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostPortScanResult. + :type: datetime + """ + self._time_finished = time_finished + + @property + def open_port_count(self): + """ + Gets the open_port_count of this HostPortScanResult. + Total number of open ports across all attached VNICs found in this scan + + + :return: The open_port_count of this HostPortScanResult. + :rtype: int + """ + return self._open_port_count + + @open_port_count.setter + def open_port_count(self, open_port_count): + """ + Sets the open_port_count of this HostPortScanResult. + Total number of open ports across all attached VNICs found in this scan + + + :param open_port_count: The open_port_count of this HostPortScanResult. + :type: int + """ + self._open_port_count = open_port_count + + @property + def open_ports(self): + """ + **[Required]** Gets the open_ports of this HostPortScanResult. + List of open ports (including interface) found in this scan + + + :return: The open_ports of this HostPortScanResult. + :rtype: list[oci.vulnerability_scanning.models.HostPortScanResultOpenPort] + """ + return self._open_ports + + @open_ports.setter + def open_ports(self, open_ports): + """ + Sets the open_ports of this HostPortScanResult. + List of open ports (including interface) found in this scan + + + :param open_ports: The open_ports of this HostPortScanResult. + :type: list[oci.vulnerability_scanning.models.HostPortScanResultOpenPort] + """ + self._open_ports = open_ports + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostPortScanResult. + The current state of the result. + + 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 HostPortScanResult. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostPortScanResult. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostPortScanResult. + :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 + + 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/vulnerability_scanning/models/host_port_scan_result_open_port.py b/src/oci/vulnerability_scanning/models/host_port_scan_result_open_port.py new file mode 100644 index 0000000000..0f7b761adb --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_port_scan_result_open_port.py @@ -0,0 +1,253 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostPortScanResultOpenPort(object): + """ + An open port found in a host port scan + """ + + #: A constant which can be used with the severity property of a HostPortScanResultOpenPort. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a HostPortScanResultOpenPort. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a HostPortScanResultOpenPort. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a HostPortScanResultOpenPort. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a HostPortScanResultOpenPort. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + def __init__(self, **kwargs): + """ + Initializes a new HostPortScanResultOpenPort object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param port: + The value to assign to the port property of this HostPortScanResultOpenPort. + :type port: int + + :param protocol: + The value to assign to the protocol property of this HostPortScanResultOpenPort. + :type protocol: str + + :param ip_address: + The value to assign to the ip_address property of this HostPortScanResultOpenPort. + :type ip_address: str + + :param vnic_id: + The value to assign to the vnic_id property of this HostPortScanResultOpenPort. + :type vnic_id: str + + :param service: + The value to assign to the service property of this HostPortScanResultOpenPort. + :type service: str + + :param severity: + The value to assign to the severity property of this HostPortScanResultOpenPort. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + """ + self.swagger_types = { + 'port': 'int', + 'protocol': 'str', + 'ip_address': 'str', + 'vnic_id': 'str', + 'service': 'str', + 'severity': 'str' + } + + self.attribute_map = { + 'port': 'port', + 'protocol': 'protocol', + 'ip_address': 'ipAddress', + 'vnic_id': 'vnicId', + 'service': 'service', + 'severity': 'severity' + } + + self._port = None + self._protocol = None + self._ip_address = None + self._vnic_id = None + self._service = None + self._severity = None + + @property + def port(self): + """ + **[Required]** Gets the port of this HostPortScanResultOpenPort. + Open port + + + :return: The port of this HostPortScanResultOpenPort. + :rtype: int + """ + return self._port + + @port.setter + def port(self, port): + """ + Sets the port of this HostPortScanResultOpenPort. + Open port + + + :param port: The port of this HostPortScanResultOpenPort. + :type: int + """ + self._port = port + + @property + def protocol(self): + """ + **[Required]** Gets the protocol of this HostPortScanResultOpenPort. + Protocol of the open port + + + :return: The protocol of this HostPortScanResultOpenPort. + :rtype: str + """ + return self._protocol + + @protocol.setter + def protocol(self, protocol): + """ + Sets the protocol of this HostPortScanResultOpenPort. + Protocol of the open port + + + :param protocol: The protocol of this HostPortScanResultOpenPort. + :type: str + """ + self._protocol = protocol + + @property + def ip_address(self): + """ + **[Required]** Gets the ip_address of this HostPortScanResultOpenPort. + IP Address open port was found on + + + :return: The ip_address of this HostPortScanResultOpenPort. + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """ + Sets the ip_address of this HostPortScanResultOpenPort. + IP Address open port was found on + + + :param ip_address: The ip_address of this HostPortScanResultOpenPort. + :type: str + """ + self._ip_address = ip_address + + @property + def vnic_id(self): + """ + **[Required]** Gets the vnic_id of this HostPortScanResultOpenPort. + ID of the attached VNIC that exposed the IP Address scanned + + + :return: The vnic_id of this HostPortScanResultOpenPort. + :rtype: str + """ + return self._vnic_id + + @vnic_id.setter + def vnic_id(self, vnic_id): + """ + Sets the vnic_id of this HostPortScanResultOpenPort. + ID of the attached VNIC that exposed the IP Address scanned + + + :param vnic_id: The vnic_id of this HostPortScanResultOpenPort. + :type: str + """ + self._vnic_id = vnic_id + + @property + def service(self): + """ + Gets the service of this HostPortScanResultOpenPort. + Service running on the port (if detected) + + + :return: The service of this HostPortScanResultOpenPort. + :rtype: str + """ + return self._service + + @service.setter + def service(self, service): + """ + Sets the service of this HostPortScanResultOpenPort. + Service running on the port (if detected) + + + :param service: The service of this HostPortScanResultOpenPort. + :type: str + """ + self._service = service + + @property + def severity(self): + """ + **[Required]** Gets the severity of this HostPortScanResultOpenPort. + Problem severity + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this HostPortScanResultOpenPort. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this HostPortScanResultOpenPort. + Problem severity + + + :param severity: The severity of this HostPortScanResultOpenPort. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + 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/vulnerability_scanning/models/host_port_scan_result_summary.py b/src/oci/vulnerability_scanning/models/host_port_scan_result_summary.py new file mode 100644 index 0000000000..50316e6d69 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_port_scan_result_summary.py @@ -0,0 +1,386 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostPortScanResultSummary(object): + """ + A summary of a result for a host agent scan + """ + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResultSummary. + #: This constant has a value of "NONE" + HIGHEST_PROBLEM_SEVERITY_NONE = "NONE" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResultSummary. + #: This constant has a value of "LOW" + HIGHEST_PROBLEM_SEVERITY_LOW = "LOW" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResultSummary. + #: This constant has a value of "MEDIUM" + HIGHEST_PROBLEM_SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResultSummary. + #: This constant has a value of "HIGH" + HIGHEST_PROBLEM_SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the highest_problem_severity property of a HostPortScanResultSummary. + #: This constant has a value of "CRITICAL" + HIGHEST_PROBLEM_SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostPortScanResultSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostPortScanResultSummary 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 HostPortScanResultSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostPortScanResultSummary. + :type display_name: str + + :param instance_id: + The value to assign to the instance_id property of this HostPortScanResultSummary. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostPortScanResultSummary. + :type compartment_id: str + + :param highest_problem_severity: + The value to assign to the highest_problem_severity property of this HostPortScanResultSummary. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type highest_problem_severity: str + + :param open_port_count: + The value to assign to the open_port_count property of this HostPortScanResultSummary. + :type open_port_count: int + + :param time_started: + The value to assign to the time_started property of this HostPortScanResultSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this HostPortScanResultSummary. + :type time_finished: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostPortScanResultSummary. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'instance_id': 'str', + 'compartment_id': 'str', + 'highest_problem_severity': 'str', + 'open_port_count': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'highest_problem_severity': 'highestProblemSeverity', + 'open_port_count': 'openPortCount', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._instance_id = None + self._compartment_id = None + self._highest_problem_severity = None + self._open_port_count = None + self._time_started = None + self._time_finished = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostPortScanResultSummary. + Unique identifier of the scan + + + :return: The id of this HostPortScanResultSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostPortScanResultSummary. + Unique identifier of the scan + + + :param id: The id of this HostPortScanResultSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this HostPortScanResultSummary. + Name of the resource + + + :return: The display_name of this HostPortScanResultSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostPortScanResultSummary. + Name of the resource + + + :param display_name: The display_name of this HostPortScanResultSummary. + :type: str + """ + self._display_name = display_name + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostPortScanResultSummary. + Instance ID of the Compute Instance scanned + + + :return: The instance_id of this HostPortScanResultSummary. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostPortScanResultSummary. + Instance ID of the Compute Instance scanned + + + :param instance_id: The instance_id of this HostPortScanResultSummary. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostPortScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :return: The compartment_id of this HostPortScanResultSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostPortScanResultSummary. + Compartment ID of the resource. This is set to the same as the compartment ID of the scan target + + + :param compartment_id: The compartment_id of this HostPortScanResultSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def highest_problem_severity(self): + """ + **[Required]** Gets the highest_problem_severity of this HostPortScanResultSummary. + Highest problem severity in this report + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The highest_problem_severity of this HostPortScanResultSummary. + :rtype: str + """ + return self._highest_problem_severity + + @highest_problem_severity.setter + def highest_problem_severity(self, highest_problem_severity): + """ + Sets the highest_problem_severity of this HostPortScanResultSummary. + Highest problem severity in this report + + + :param highest_problem_severity: The highest_problem_severity of this HostPortScanResultSummary. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(highest_problem_severity, allowed_values): + highest_problem_severity = 'UNKNOWN_ENUM_VALUE' + self._highest_problem_severity = highest_problem_severity + + @property + def open_port_count(self): + """ + **[Required]** Gets the open_port_count of this HostPortScanResultSummary. + Total number of open ports across all attached VNICs found in this scan + + + :return: The open_port_count of this HostPortScanResultSummary. + :rtype: int + """ + return self._open_port_count + + @open_port_count.setter + def open_port_count(self, open_port_count): + """ + Sets the open_port_count of this HostPortScanResultSummary. + Total number of open ports across all attached VNICs found in this scan + + + :param open_port_count: The open_port_count of this HostPortScanResultSummary. + :type: int + """ + self._open_port_count = open_port_count + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this HostPortScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this HostPortScanResultSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this HostPortScanResultSummary. + Date and time the scan was started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this HostPortScanResultSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this HostPortScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this HostPortScanResultSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this HostPortScanResultSummary. + Date and time the scan was completed, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this HostPortScanResultSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostPortScanResultSummary. + The current state of the result. + + 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 HostPortScanResultSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostPortScanResultSummary. + The current state of the result. + + + :param lifecycle_state: The lifecycle_state of this HostPortScanResultSummary. + :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 + + 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/vulnerability_scanning/models/host_port_scan_result_summary_collection.py b/src/oci/vulnerability_scanning/models/host_port_scan_result_summary_collection.py new file mode 100644 index 0000000000..06fea74cb5 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_port_scan_result_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostPortScanResultSummaryCollection(object): + """ + A collection of HostPortScanResultSummary + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostPortScanResultSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostPortScanResultSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostPortScanResultSummary] + + """ + self.swagger_types = { + 'items': 'list[HostPortScanResultSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostPortScanResultSummaryCollection. + The HostPortScanResultSummary objects in the collection + + + :return: The items of this HostPortScanResultSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostPortScanResultSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostPortScanResultSummaryCollection. + The HostPortScanResultSummary objects in the collection + + + :param items: The items of this HostPortScanResultSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostPortScanResultSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_scan_agent_configuration.py b/src/oci/vulnerability_scanning/models/host_scan_agent_configuration.py new file mode 100644 index 0000000000..9a5f125ceb --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_agent_configuration.py @@ -0,0 +1,99 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanAgentConfiguration(object): + """ + Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor. + """ + + #: A constant which can be used with the vendor property of a HostScanAgentConfiguration. + #: This constant has a value of "OCI" + VENDOR_OCI = "OCI" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanAgentConfiguration 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.vulnerability_scanning.models.HostScanAgentConfigurationOCI` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vendor: + The value to assign to the vendor property of this HostScanAgentConfiguration. + Allowed values for this property are: "OCI", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type vendor: str + + """ + self.swagger_types = { + 'vendor': 'str' + } + + self.attribute_map = { + 'vendor': 'vendor' + } + + self._vendor = 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['vendor'] + + if type == 'OCI': + return 'HostScanAgentConfigurationOCI' + else: + return 'HostScanAgentConfiguration' + + @property + def vendor(self): + """ + **[Required]** Gets the vendor of this HostScanAgentConfiguration. + Vendor to use for the host scan agent. + + Allowed values for this property are: "OCI", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The vendor of this HostScanAgentConfiguration. + :rtype: str + """ + return self._vendor + + @vendor.setter + def vendor(self, vendor): + """ + Sets the vendor of this HostScanAgentConfiguration. + Vendor to use for the host scan agent. + + + :param vendor: The vendor of this HostScanAgentConfiguration. + :type: str + """ + allowed_values = ["OCI"] + if not value_allowed_none_or_none_sentinel(vendor, allowed_values): + vendor = 'UNKNOWN_ENUM_VALUE' + self._vendor = vendor + + 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/vulnerability_scanning/models/host_scan_agent_configuration_oci.py b/src/oci/vulnerability_scanning/models/host_scan_agent_configuration_oci.py new file mode 100644 index 0000000000..f756e1cb06 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_agent_configuration_oci.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .host_scan_agent_configuration import HostScanAgentConfiguration +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 HostScanAgentConfigurationOCI(HostScanAgentConfiguration): + """ + Agent configuration options for the OCI host scan agent + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostScanAgentConfigurationOCI object with values from keyword arguments. The default value of the :py:attr:`~oci.vulnerability_scanning.models.HostScanAgentConfigurationOCI.vendor` attribute + of this class is ``OCI`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vendor: + The value to assign to the vendor property of this HostScanAgentConfigurationOCI. + Allowed values for this property are: "OCI" + :type vendor: str + + :param cis_benchmark_settings: + The value to assign to the cis_benchmark_settings property of this HostScanAgentConfigurationOCI. + :type cis_benchmark_settings: oci.vulnerability_scanning.models.HostCisBenchmarkSettings + + :param endpoint_protection_settings: + The value to assign to the endpoint_protection_settings property of this HostScanAgentConfigurationOCI. + :type endpoint_protection_settings: oci.vulnerability_scanning.models.HostEndpointProtectionSettings + + """ + self.swagger_types = { + 'vendor': 'str', + 'cis_benchmark_settings': 'HostCisBenchmarkSettings', + 'endpoint_protection_settings': 'HostEndpointProtectionSettings' + } + + self.attribute_map = { + 'vendor': 'vendor', + 'cis_benchmark_settings': 'cisBenchmarkSettings', + 'endpoint_protection_settings': 'endpointProtectionSettings' + } + + self._vendor = None + self._cis_benchmark_settings = None + self._endpoint_protection_settings = None + self._vendor = 'OCI' + + @property + def cis_benchmark_settings(self): + """ + Gets the cis_benchmark_settings of this HostScanAgentConfigurationOCI. + + :return: The cis_benchmark_settings of this HostScanAgentConfigurationOCI. + :rtype: oci.vulnerability_scanning.models.HostCisBenchmarkSettings + """ + return self._cis_benchmark_settings + + @cis_benchmark_settings.setter + def cis_benchmark_settings(self, cis_benchmark_settings): + """ + Sets the cis_benchmark_settings of this HostScanAgentConfigurationOCI. + + :param cis_benchmark_settings: The cis_benchmark_settings of this HostScanAgentConfigurationOCI. + :type: oci.vulnerability_scanning.models.HostCisBenchmarkSettings + """ + self._cis_benchmark_settings = cis_benchmark_settings + + @property + def endpoint_protection_settings(self): + """ + Gets the endpoint_protection_settings of this HostScanAgentConfigurationOCI. + + :return: The endpoint_protection_settings of this HostScanAgentConfigurationOCI. + :rtype: oci.vulnerability_scanning.models.HostEndpointProtectionSettings + """ + return self._endpoint_protection_settings + + @endpoint_protection_settings.setter + def endpoint_protection_settings(self, endpoint_protection_settings): + """ + Sets the endpoint_protection_settings of this HostScanAgentConfigurationOCI. + + :param endpoint_protection_settings: The endpoint_protection_settings of this HostScanAgentConfigurationOCI. + :type: oci.vulnerability_scanning.models.HostEndpointProtectionSettings + """ + self._endpoint_protection_settings = endpoint_protection_settings + + 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/vulnerability_scanning/models/host_scan_agent_settings.py b/src/oci/vulnerability_scanning/models/host_scan_agent_settings.py new file mode 100644 index 0000000000..f8644bfac5 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_agent_settings.py @@ -0,0 +1,113 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanAgentSettings(object): + """ + Agent scan settings for a host scan + """ + + #: A constant which can be used with the scan_level property of a HostScanAgentSettings. + #: This constant has a value of "NONE" + SCAN_LEVEL_NONE = "NONE" + + #: A constant which can be used with the scan_level property of a HostScanAgentSettings. + #: This constant has a value of "STANDARD" + SCAN_LEVEL_STANDARD = "STANDARD" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanAgentSettings object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param scan_level: + The value to assign to the scan_level property of this HostScanAgentSettings. + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type scan_level: str + + :param agent_configuration: + The value to assign to the agent_configuration property of this HostScanAgentSettings. + :type agent_configuration: oci.vulnerability_scanning.models.HostScanAgentConfiguration + + """ + self.swagger_types = { + 'scan_level': 'str', + 'agent_configuration': 'HostScanAgentConfiguration' + } + + self.attribute_map = { + 'scan_level': 'scanLevel', + 'agent_configuration': 'agentConfiguration' + } + + self._scan_level = None + self._agent_configuration = None + + @property + def scan_level(self): + """ + **[Required]** Gets the scan_level of this HostScanAgentSettings. + The scan level + + Allowed values for this property are: "NONE", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The scan_level of this HostScanAgentSettings. + :rtype: str + """ + return self._scan_level + + @scan_level.setter + def scan_level(self, scan_level): + """ + Sets the scan_level of this HostScanAgentSettings. + The scan level + + + :param scan_level: The scan_level of this HostScanAgentSettings. + :type: str + """ + allowed_values = ["NONE", "STANDARD"] + if not value_allowed_none_or_none_sentinel(scan_level, allowed_values): + scan_level = 'UNKNOWN_ENUM_VALUE' + self._scan_level = scan_level + + @property + def agent_configuration(self): + """ + Gets the agent_configuration of this HostScanAgentSettings. + + :return: The agent_configuration of this HostScanAgentSettings. + :rtype: oci.vulnerability_scanning.models.HostScanAgentConfiguration + """ + return self._agent_configuration + + @agent_configuration.setter + def agent_configuration(self, agent_configuration): + """ + Sets the agent_configuration of this HostScanAgentSettings. + + :param agent_configuration: The agent_configuration of this HostScanAgentSettings. + :type: oci.vulnerability_scanning.models.HostScanAgentConfiguration + """ + self._agent_configuration = agent_configuration + + 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/vulnerability_scanning/models/host_scan_port_settings.py b/src/oci/vulnerability_scanning/models/host_scan_port_settings.py new file mode 100644 index 0000000000..86c05ff69d --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_port_settings.py @@ -0,0 +1,90 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanPortSettings(object): + """ + Port scan settings for a host scan + """ + + #: A constant which can be used with the scan_level property of a HostScanPortSettings. + #: This constant has a value of "NONE" + SCAN_LEVEL_NONE = "NONE" + + #: A constant which can be used with the scan_level property of a HostScanPortSettings. + #: This constant has a value of "LIGHT" + SCAN_LEVEL_LIGHT = "LIGHT" + + #: A constant which can be used with the scan_level property of a HostScanPortSettings. + #: This constant has a value of "STANDARD" + SCAN_LEVEL_STANDARD = "STANDARD" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanPortSettings object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param scan_level: + The value to assign to the scan_level property of this HostScanPortSettings. + Allowed values for this property are: "NONE", "LIGHT", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type scan_level: str + + """ + self.swagger_types = { + 'scan_level': 'str' + } + + self.attribute_map = { + 'scan_level': 'scanLevel' + } + + self._scan_level = None + + @property + def scan_level(self): + """ + **[Required]** Gets the scan_level of this HostScanPortSettings. + The scan level + + Allowed values for this property are: "NONE", "LIGHT", "STANDARD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The scan_level of this HostScanPortSettings. + :rtype: str + """ + return self._scan_level + + @scan_level.setter + def scan_level(self, scan_level): + """ + Sets the scan_level of this HostScanPortSettings. + The scan level + + + :param scan_level: The scan_level of this HostScanPortSettings. + :type: str + """ + allowed_values = ["NONE", "LIGHT", "STANDARD"] + if not value_allowed_none_or_none_sentinel(scan_level, allowed_values): + scan_level = 'UNKNOWN_ENUM_VALUE' + self._scan_level = scan_level + + 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/vulnerability_scanning/models/host_scan_recipe.py b/src/oci/vulnerability_scanning/models/host_scan_recipe.py new file mode 100644 index 0000000000..1503c5901e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_recipe.py @@ -0,0 +1,445 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanRecipe(object): + """ + A host scan recipe (collection of host scanning configuration settings) + """ + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipe. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanRecipe 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 HostScanRecipe. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostScanRecipe. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostScanRecipe. + :type compartment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostScanRecipe. + 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 time_created: + The value to assign to the time_created property of this HostScanRecipe. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this HostScanRecipe. + :type time_updated: datetime + + :param port_settings: + The value to assign to the port_settings property of this HostScanRecipe. + :type port_settings: oci.vulnerability_scanning.models.HostScanPortSettings + + :param agent_settings: + The value to assign to the agent_settings property of this HostScanRecipe. + :type agent_settings: oci.vulnerability_scanning.models.HostScanAgentSettings + + :param schedule: + The value to assign to the schedule property of this HostScanRecipe. + :type schedule: oci.vulnerability_scanning.models.Schedule + + :param freeform_tags: + The value to assign to the freeform_tags property of this HostScanRecipe. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this HostScanRecipe. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this HostScanRecipe. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'port_settings': 'HostScanPortSettings', + 'agent_settings': 'HostScanAgentSettings', + 'schedule': 'Schedule', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'port_settings': 'portSettings', + 'agent_settings': 'agentSettings', + 'schedule': 'schedule', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._port_settings = None + self._agent_settings = None + self._schedule = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostScanRecipe. + Unique identifier of the config that is immutable on creation + + + :return: The id of this HostScanRecipe. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostScanRecipe. + Unique identifier of the config that is immutable on creation + + + :param id: The id of this HostScanRecipe. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this HostScanRecipe. + Recipe identifier, which can be renamed + + + :return: The display_name of this HostScanRecipe. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostScanRecipe. + Recipe identifier, which can be renamed + + + :param display_name: The display_name of this HostScanRecipe. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostScanRecipe. + Compartment ID of the scan recipe + + + :return: The compartment_id of this HostScanRecipe. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostScanRecipe. + Compartment ID of the scan recipe + + + :param compartment_id: The compartment_id of this HostScanRecipe. + :type: str + """ + self._compartment_id = compartment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this HostScanRecipe. + The current state of the config. + + 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 HostScanRecipe. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostScanRecipe. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this HostScanRecipe. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this HostScanRecipe. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this HostScanRecipe. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this HostScanRecipe. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this HostScanRecipe. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this HostScanRecipe. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this HostScanRecipe. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this HostScanRecipe. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this HostScanRecipe. + :type: datetime + """ + self._time_updated = time_updated + + @property + def port_settings(self): + """ + **[Required]** Gets the port_settings of this HostScanRecipe. + + :return: The port_settings of this HostScanRecipe. + :rtype: oci.vulnerability_scanning.models.HostScanPortSettings + """ + return self._port_settings + + @port_settings.setter + def port_settings(self, port_settings): + """ + Sets the port_settings of this HostScanRecipe. + + :param port_settings: The port_settings of this HostScanRecipe. + :type: oci.vulnerability_scanning.models.HostScanPortSettings + """ + self._port_settings = port_settings + + @property + def agent_settings(self): + """ + **[Required]** Gets the agent_settings of this HostScanRecipe. + + :return: The agent_settings of this HostScanRecipe. + :rtype: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + return self._agent_settings + + @agent_settings.setter + def agent_settings(self, agent_settings): + """ + Sets the agent_settings of this HostScanRecipe. + + :param agent_settings: The agent_settings of this HostScanRecipe. + :type: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + self._agent_settings = agent_settings + + @property + def schedule(self): + """ + **[Required]** Gets the schedule of this HostScanRecipe. + + :return: The schedule of this HostScanRecipe. + :rtype: oci.vulnerability_scanning.models.Schedule + """ + return self._schedule + + @schedule.setter + def schedule(self, schedule): + """ + Sets the schedule of this HostScanRecipe. + + :param schedule: The schedule of this HostScanRecipe. + :type: oci.vulnerability_scanning.models.Schedule + """ + self._schedule = schedule + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this HostScanRecipe. + 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 HostScanRecipe. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this HostScanRecipe. + 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 HostScanRecipe. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this HostScanRecipe. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this HostScanRecipe. + :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 HostScanRecipe. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this HostScanRecipe. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this HostScanRecipe. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this HostScanRecipe. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this HostScanRecipe. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this HostScanRecipe. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/host_scan_recipe_summary.py b/src/oci/vulnerability_scanning/models/host_scan_recipe_summary.py new file mode 100644 index 0000000000..09b291c645 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_recipe_summary.py @@ -0,0 +1,364 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanRecipeSummary(object): + """ + Summary of a host scan recipe (collection of host scanning configuration settings) + """ + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostScanRecipeSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanRecipeSummary 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 HostScanRecipeSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostScanRecipeSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostScanRecipeSummary. + :type compartment_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostScanRecipeSummary. + 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 time_created: + The value to assign to the time_created property of this HostScanRecipeSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this HostScanRecipeSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this HostScanRecipeSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this HostScanRecipeSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this HostScanRecipeSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostScanRecipeSummary. + Unique identifier of the config that is immutable on creation + + + :return: The id of this HostScanRecipeSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostScanRecipeSummary. + Unique identifier of the config that is immutable on creation + + + :param id: The id of this HostScanRecipeSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this HostScanRecipeSummary. + Recipe identifier, which can be renamed. + + + :return: The display_name of this HostScanRecipeSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostScanRecipeSummary. + Recipe identifier, which can be renamed. + + + :param display_name: The display_name of this HostScanRecipeSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostScanRecipeSummary. + Compartment ID of the scan recipe + + + :return: The compartment_id of this HostScanRecipeSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostScanRecipeSummary. + Compartment ID of the scan recipe + + + :param compartment_id: The compartment_id of this HostScanRecipeSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this HostScanRecipeSummary. + The current state of the config. + + 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 HostScanRecipeSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostScanRecipeSummary. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this HostScanRecipeSummary. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this HostScanRecipeSummary. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this HostScanRecipeSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this HostScanRecipeSummary. + Date and time the recipe was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this HostScanRecipeSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this HostScanRecipeSummary. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this HostScanRecipeSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this HostScanRecipeSummary. + Date and time the recipe was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this HostScanRecipeSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this HostScanRecipeSummary. + 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 HostScanRecipeSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this HostScanRecipeSummary. + 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 HostScanRecipeSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this HostScanRecipeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this HostScanRecipeSummary. + :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 HostScanRecipeSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this HostScanRecipeSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this HostScanRecipeSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this HostScanRecipeSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this HostScanRecipeSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this HostScanRecipeSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/host_scan_recipe_summary_collection.py b/src/oci/vulnerability_scanning/models/host_scan_recipe_summary_collection.py new file mode 100644 index 0000000000..7d5ce01685 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_recipe_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanRecipeSummaryCollection(object): + """ + A collection of HostScanRecipeSummary objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostScanRecipeSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostScanRecipeSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostScanRecipeSummary] + + """ + self.swagger_types = { + 'items': 'list[HostScanRecipeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostScanRecipeSummaryCollection. + The HostScanRecipeSummary objects in the collection + + + :return: The items of this HostScanRecipeSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostScanRecipeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostScanRecipeSummaryCollection. + The HostScanRecipeSummary objects in the collection + + + :param items: The items of this HostScanRecipeSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostScanRecipeSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_scan_target.py b/src/oci/vulnerability_scanning/models/host_scan_target.py new file mode 100644 index 0000000000..bee57ac281 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_target.py @@ -0,0 +1,488 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanTarget(object): + """ + A host scan target (application of a host scan recipe to a compartment or list of hosts) + """ + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostScanTarget. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanTarget 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 HostScanTarget. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostScanTarget. + :type display_name: str + + :param description: + The value to assign to the description property of this HostScanTarget. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostScanTarget. + :type compartment_id: str + + :param target_compartment_id: + The value to assign to the target_compartment_id property of this HostScanTarget. + :type target_compartment_id: str + + :param instance_ids: + The value to assign to the instance_ids property of this HostScanTarget. + :type instance_ids: list[str] + + :param host_scan_recipe_id: + The value to assign to the host_scan_recipe_id property of this HostScanTarget. + :type host_scan_recipe_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostScanTarget. + 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 time_created: + The value to assign to the time_created property of this HostScanTarget. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this HostScanTarget. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this HostScanTarget. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this HostScanTarget. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this HostScanTarget. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'target_compartment_id': 'str', + 'instance_ids': 'list[str]', + 'host_scan_recipe_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'target_compartment_id': 'targetCompartmentId', + 'instance_ids': 'instanceIds', + 'host_scan_recipe_id': 'hostScanRecipeId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._target_compartment_id = None + self._instance_ids = None + self._host_scan_recipe_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostScanTarget. + Unique identifier of the config that is immutable on creation + + + :return: The id of this HostScanTarget. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostScanTarget. + Unique identifier of the config that is immutable on creation + + + :param id: The id of this HostScanTarget. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this HostScanTarget. + Target identifier, which can be renamed. + + + :return: The display_name of this HostScanTarget. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostScanTarget. + Target identifier, which can be renamed. + + + :param display_name: The display_name of this HostScanTarget. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this HostScanTarget. + Target description. + + + :return: The description of this HostScanTarget. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this HostScanTarget. + Target description. + + + :param description: The description of this HostScanTarget. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostScanTarget. + Compartment ID of the object (this). + + + :return: The compartment_id of this HostScanTarget. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostScanTarget. + Compartment ID of the object (this). + + + :param compartment_id: The compartment_id of this HostScanTarget. + :type: str + """ + self._compartment_id = compartment_id + + @property + def target_compartment_id(self): + """ + **[Required]** Gets the target_compartment_id of this HostScanTarget. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :return: The target_compartment_id of this HostScanTarget. + :rtype: str + """ + return self._target_compartment_id + + @target_compartment_id.setter + def target_compartment_id(self, target_compartment_id): + """ + Sets the target_compartment_id of this HostScanTarget. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :param target_compartment_id: The target_compartment_id of this HostScanTarget. + :type: str + """ + self._target_compartment_id = target_compartment_id + + @property + def instance_ids(self): + """ + Gets the instance_ids of this HostScanTarget. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :return: The instance_ids of this HostScanTarget. + :rtype: list[str] + """ + return self._instance_ids + + @instance_ids.setter + def instance_ids(self, instance_ids): + """ + Sets the instance_ids of this HostScanTarget. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :param instance_ids: The instance_ids of this HostScanTarget. + :type: list[str] + """ + self._instance_ids = instance_ids + + @property + def host_scan_recipe_id(self): + """ + **[Required]** Gets the host_scan_recipe_id of this HostScanTarget. + ID of the host scan recipe this target applies. + + + :return: The host_scan_recipe_id of this HostScanTarget. + :rtype: str + """ + return self._host_scan_recipe_id + + @host_scan_recipe_id.setter + def host_scan_recipe_id(self, host_scan_recipe_id): + """ + Sets the host_scan_recipe_id of this HostScanTarget. + ID of the host scan recipe this target applies. + + + :param host_scan_recipe_id: The host_scan_recipe_id of this HostScanTarget. + :type: str + """ + self._host_scan_recipe_id = host_scan_recipe_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this HostScanTarget. + The current state of the config. + + 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 HostScanTarget. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostScanTarget. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this HostScanTarget. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this HostScanTarget. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this HostScanTarget. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this HostScanTarget. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this HostScanTarget. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this HostScanTarget. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this HostScanTarget. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this HostScanTarget. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this HostScanTarget. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this HostScanTarget. + 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 HostScanTarget. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this HostScanTarget. + 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 HostScanTarget. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this HostScanTarget. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this HostScanTarget. + :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 HostScanTarget. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this HostScanTarget. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this HostScanTarget. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this HostScanTarget. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this HostScanTarget. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this HostScanTarget. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/host_scan_target_summary.py b/src/oci/vulnerability_scanning/models/host_scan_target_summary.py new file mode 100644 index 0000000000..db625b6532 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_target_summary.py @@ -0,0 +1,457 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanTargetSummary(object): + """ + Summary of a host scan target (application of a host scan recipe to a compartment or list of hosts) + """ + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostScanTargetSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostScanTargetSummary 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 HostScanTargetSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this HostScanTargetSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostScanTargetSummary. + :type compartment_id: str + + :param target_compartment_id: + The value to assign to the target_compartment_id property of this HostScanTargetSummary. + :type target_compartment_id: str + + :param instance_ids: + The value to assign to the instance_ids property of this HostScanTargetSummary. + :type instance_ids: list[str] + + :param host_scan_recipe_id: + The value to assign to the host_scan_recipe_id property of this HostScanTargetSummary. + :type host_scan_recipe_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostScanTargetSummary. + 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 time_created: + The value to assign to the time_created property of this HostScanTargetSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this HostScanTargetSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this HostScanTargetSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this HostScanTargetSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this HostScanTargetSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'target_compartment_id': 'str', + 'instance_ids': 'list[str]', + 'host_scan_recipe_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'target_compartment_id': 'targetCompartmentId', + 'instance_ids': 'instanceIds', + 'host_scan_recipe_id': 'hostScanRecipeId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._target_compartment_id = None + self._instance_ids = None + self._host_scan_recipe_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostScanTargetSummary. + Unique identifier of the config that is immutable on creation + + + :return: The id of this HostScanTargetSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostScanTargetSummary. + Unique identifier of the config that is immutable on creation + + + :param id: The id of this HostScanTargetSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this HostScanTargetSummary. + Target identifier, which can be renamed. + + + :return: The display_name of this HostScanTargetSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this HostScanTargetSummary. + Target identifier, which can be renamed. + + + :param display_name: The display_name of this HostScanTargetSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostScanTargetSummary. + Compartment ID of the object (this). + + + :return: The compartment_id of this HostScanTargetSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostScanTargetSummary. + Compartment ID of the object (this). + + + :param compartment_id: The compartment_id of this HostScanTargetSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def target_compartment_id(self): + """ + **[Required]** Gets the target_compartment_id of this HostScanTargetSummary. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :return: The target_compartment_id of this HostScanTargetSummary. + :rtype: str + """ + return self._target_compartment_id + + @target_compartment_id.setter + def target_compartment_id(self, target_compartment_id): + """ + Sets the target_compartment_id of this HostScanTargetSummary. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :param target_compartment_id: The target_compartment_id of this HostScanTargetSummary. + :type: str + """ + self._target_compartment_id = target_compartment_id + + @property + def instance_ids(self): + """ + Gets the instance_ids of this HostScanTargetSummary. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :return: The instance_ids of this HostScanTargetSummary. + :rtype: list[str] + """ + return self._instance_ids + + @instance_ids.setter + def instance_ids(self, instance_ids): + """ + Sets the instance_ids of this HostScanTargetSummary. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :param instance_ids: The instance_ids of this HostScanTargetSummary. + :type: list[str] + """ + self._instance_ids = instance_ids + + @property + def host_scan_recipe_id(self): + """ + **[Required]** Gets the host_scan_recipe_id of this HostScanTargetSummary. + ID of the host scan recipe this target applies. + + + :return: The host_scan_recipe_id of this HostScanTargetSummary. + :rtype: str + """ + return self._host_scan_recipe_id + + @host_scan_recipe_id.setter + def host_scan_recipe_id(self, host_scan_recipe_id): + """ + Sets the host_scan_recipe_id of this HostScanTargetSummary. + ID of the host scan recipe this target applies. + + + :param host_scan_recipe_id: The host_scan_recipe_id of this HostScanTargetSummary. + :type: str + """ + self._host_scan_recipe_id = host_scan_recipe_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this HostScanTargetSummary. + The current state of the config. + + 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 HostScanTargetSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostScanTargetSummary. + The current state of the config. + + + :param lifecycle_state: The lifecycle_state of this HostScanTargetSummary. + :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 time_created(self): + """ + **[Required]** Gets the time_created of this HostScanTargetSummary. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_created of this HostScanTargetSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this HostScanTargetSummary. + Date and time the target was created, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_created: The time_created of this HostScanTargetSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this HostScanTargetSummary. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_updated of this HostScanTargetSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this HostScanTargetSummary. + Date and time the target was last updated, format as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_updated: The time_updated of this HostScanTargetSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this HostScanTargetSummary. + 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 HostScanTargetSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this HostScanTargetSummary. + 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 HostScanTargetSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this HostScanTargetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this HostScanTargetSummary. + :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 HostScanTargetSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this HostScanTargetSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this HostScanTargetSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this HostScanTargetSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this HostScanTargetSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this HostScanTargetSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_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/vulnerability_scanning/models/host_scan_target_summary_collection.py b/src/oci/vulnerability_scanning/models/host_scan_target_summary_collection.py new file mode 100644 index 0000000000..ac5c576356 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_scan_target_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostScanTargetSummaryCollection(object): + """ + A collection of HostScanTargetSummary objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostScanTargetSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostScanTargetSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostScanTargetSummary] + + """ + self.swagger_types = { + 'items': 'list[HostScanTargetSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostScanTargetSummaryCollection. + The HostScanTargetSummary objects in the collection + + + :return: The items of this HostScanTargetSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostScanTargetSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostScanTargetSummaryCollection. + The HostScanTargetSummary objects in the collection + + + :param items: The items of this HostScanTargetSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostScanTargetSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_vulnerability.py b/src/oci/vulnerability_scanning/models/host_vulnerability.py new file mode 100644 index 0000000000..c746662b1c --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_vulnerability.py @@ -0,0 +1,534 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostVulnerability(object): + """ + A vulnerability found in one or more host scans in a compartment + """ + + #: A constant which can be used with the severity property of a HostVulnerability. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a HostVulnerability. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a HostVulnerability. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a HostVulnerability. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a HostVulnerability. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the state property of a HostVulnerability. + #: This constant has a value of "OPEN" + STATE_OPEN = "OPEN" + + #: A constant which can be used with the state property of a HostVulnerability. + #: This constant has a value of "FIXED" + STATE_FIXED = "FIXED" + + #: A constant which can be used with the state property of a HostVulnerability. + #: This constant has a value of "NOT_APPLICABLE" + STATE_NOT_APPLICABLE = "NOT_APPLICABLE" + + #: A constant which can be used with the vulnerability_type property of a HostVulnerability. + #: This constant has a value of "CVE" + VULNERABILITY_TYPE_CVE = "CVE" + + #: A constant which can be used with the vulnerability_type property of a HostVulnerability. + #: This constant has a value of "PROBLEM" + VULNERABILITY_TYPE_PROBLEM = "PROBLEM" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerability. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostVulnerability 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 HostVulnerability. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostVulnerability. + :type compartment_id: str + + :param authentication: + The value to assign to the authentication property of this HostVulnerability. + :type authentication: str + + :param cve_reference: + The value to assign to the cve_reference property of this HostVulnerability. + :type cve_reference: str + + :param cve_details: + The value to assign to the cve_details property of this HostVulnerability. + :type cve_details: oci.vulnerability_scanning.models.CveDetails + + :param severity: + The value to assign to the severity property of this HostVulnerability. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param state: + The value to assign to the state property of this HostVulnerability. + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param name: + The value to assign to the name property of this HostVulnerability. + :type name: str + + :param time_last_detected: + The value to assign to the time_last_detected property of this HostVulnerability. + :type time_last_detected: datetime + + :param time_first_detected: + The value to assign to the time_first_detected property of this HostVulnerability. + :type time_first_detected: datetime + + :param host_count: + The value to assign to the host_count property of this HostVulnerability. + :type host_count: int + + :param vulnerability_type: + The value to assign to the vulnerability_type property of this HostVulnerability. + Allowed values for this property are: "CVE", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type vulnerability_type: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostVulnerability. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'authentication': 'str', + 'cve_reference': 'str', + 'cve_details': 'CveDetails', + 'severity': 'str', + 'state': 'str', + 'name': 'str', + 'time_last_detected': 'datetime', + 'time_first_detected': 'datetime', + 'host_count': 'int', + 'vulnerability_type': 'str', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'authentication': 'authentication', + 'cve_reference': 'cveReference', + 'cve_details': 'cveDetails', + 'severity': 'severity', + 'state': 'state', + 'name': 'name', + 'time_last_detected': 'timeLastDetected', + 'time_first_detected': 'timeFirstDetected', + 'host_count': 'hostCount', + 'vulnerability_type': 'vulnerabilityType', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._compartment_id = None + self._authentication = None + self._cve_reference = None + self._cve_details = None + self._severity = None + self._state = None + self._name = None + self._time_last_detected = None + self._time_first_detected = None + self._host_count = None + self._vulnerability_type = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostVulnerability. + ID of the vulnerability + + + :return: The id of this HostVulnerability. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostVulnerability. + ID of the vulnerability + + + :param id: The id of this HostVulnerability. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostVulnerability. + Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments, based on scan target location + + + :return: The compartment_id of this HostVulnerability. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostVulnerability. + Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments, based on scan target location + + + :param compartment_id: The compartment_id of this HostVulnerability. + :type: str + """ + self._compartment_id = compartment_id + + @property + def authentication(self): + """ + Gets the authentication of this HostVulnerability. + Mechanism used for scan authentication + + + :return: The authentication of this HostVulnerability. + :rtype: str + """ + return self._authentication + + @authentication.setter + def authentication(self, authentication): + """ + Sets the authentication of this HostVulnerability. + Mechanism used for scan authentication + + + :param authentication: The authentication of this HostVulnerability. + :type: str + """ + self._authentication = authentication + + @property + def cve_reference(self): + """ + Gets the cve_reference of this HostVulnerability. + Reference to MITRE CVE ID + + + :return: The cve_reference of this HostVulnerability. + :rtype: str + """ + return self._cve_reference + + @cve_reference.setter + def cve_reference(self, cve_reference): + """ + Sets the cve_reference of this HostVulnerability. + Reference to MITRE CVE ID + + + :param cve_reference: The cve_reference of this HostVulnerability. + :type: str + """ + self._cve_reference = cve_reference + + @property + def cve_details(self): + """ + Gets the cve_details of this HostVulnerability. + + :return: The cve_details of this HostVulnerability. + :rtype: oci.vulnerability_scanning.models.CveDetails + """ + return self._cve_details + + @cve_details.setter + def cve_details(self, cve_details): + """ + Sets the cve_details of this HostVulnerability. + + :param cve_details: The cve_details of this HostVulnerability. + :type: oci.vulnerability_scanning.models.CveDetails + """ + self._cve_details = cve_details + + @property + def severity(self): + """ + **[Required]** Gets the severity of this HostVulnerability. + Severity of the vulnerability + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this HostVulnerability. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this HostVulnerability. + Severity of the vulnerability + + + :param severity: The severity of this HostVulnerability. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def state(self): + """ + Gets the state of this HostVulnerability. + State of the vulnerability + + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this HostVulnerability. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this HostVulnerability. + State of the vulnerability + + + :param state: The state of this HostVulnerability. + :type: str + """ + allowed_values = ["OPEN", "FIXED", "NOT_APPLICABLE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = state + + @property + def name(self): + """ + **[Required]** Gets the name of this HostVulnerability. + Vulnerability name + + + :return: The name of this HostVulnerability. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HostVulnerability. + Vulnerability name + + + :param name: The name of this HostVulnerability. + :type: str + """ + self._name = name + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this HostVulnerability. + Date of scan result that most recently reported the vulnerability + + + :return: The time_last_detected of this HostVulnerability. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this HostVulnerability. + Date of scan result that most recently reported the vulnerability + + + :param time_last_detected: The time_last_detected of this HostVulnerability. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this HostVulnerability. + Date of scan result that first reported the vulnerability + + + :return: The time_first_detected of this HostVulnerability. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this HostVulnerability. + Date of scan result that first reported the vulnerability + + + :param time_first_detected: The time_first_detected of this HostVulnerability. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def host_count(self): + """ + **[Required]** Gets the host_count of this HostVulnerability. + Number of scanned hosts in this compartment whose scan results currently report this vulnerability + + + :return: The host_count of this HostVulnerability. + :rtype: int + """ + return self._host_count + + @host_count.setter + def host_count(self, host_count): + """ + Sets the host_count of this HostVulnerability. + Number of scanned hosts in this compartment whose scan results currently report this vulnerability + + + :param host_count: The host_count of this HostVulnerability. + :type: int + """ + self._host_count = host_count + + @property + def vulnerability_type(self): + """ + **[Required]** Gets the vulnerability_type of this HostVulnerability. + Specifies the type of Vulnerability + + Allowed values for this property are: "CVE", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The vulnerability_type of this HostVulnerability. + :rtype: str + """ + return self._vulnerability_type + + @vulnerability_type.setter + def vulnerability_type(self, vulnerability_type): + """ + Sets the vulnerability_type of this HostVulnerability. + Specifies the type of Vulnerability + + + :param vulnerability_type: The vulnerability_type of this HostVulnerability. + :type: str + """ + allowed_values = ["CVE", "PROBLEM"] + if not value_allowed_none_or_none_sentinel(vulnerability_type, allowed_values): + vulnerability_type = 'UNKNOWN_ENUM_VALUE' + self._vulnerability_type = vulnerability_type + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostVulnerability. + The current state of the resource. + + 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 HostVulnerability. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostVulnerability. + The current state of the resource. + + + :param lifecycle_state: The lifecycle_state of this HostVulnerability. + :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 + + 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/vulnerability_scanning/models/host_vulnerability_impacted_host_summary.py b/src/oci/vulnerability_scanning/models/host_vulnerability_impacted_host_summary.py new file mode 100644 index 0000000000..80cf1b527b --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_vulnerability_impacted_host_summary.py @@ -0,0 +1,195 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostVulnerabilityImpactedHostSummary(object): + """ + Information on a host impacted by a vulnerability + """ + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilityImpactedHostSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostVulnerabilityImpactedHostSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param instance_id: + The value to assign to the instance_id property of this HostVulnerabilityImpactedHostSummary. + :type instance_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostVulnerabilityImpactedHostSummary. + :type compartment_id: str + + :param last_agent_scan_id: + The value to assign to the last_agent_scan_id property of this HostVulnerabilityImpactedHostSummary. + :type last_agent_scan_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostVulnerabilityImpactedHostSummary. + 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 + + """ + self.swagger_types = { + 'instance_id': 'str', + 'compartment_id': 'str', + 'last_agent_scan_id': 'str', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'instance_id': 'instanceId', + 'compartment_id': 'compartmentId', + 'last_agent_scan_id': 'lastAgentScanId', + 'lifecycle_state': 'lifecycleState' + } + + self._instance_id = None + self._compartment_id = None + self._last_agent_scan_id = None + self._lifecycle_state = None + + @property + def instance_id(self): + """ + **[Required]** Gets the instance_id of this HostVulnerabilityImpactedHostSummary. + The compute instance ID of the impacted host + + + :return: The instance_id of this HostVulnerabilityImpactedHostSummary. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this HostVulnerabilityImpactedHostSummary. + The compute instance ID of the impacted host + + + :param instance_id: The instance_id of this HostVulnerabilityImpactedHostSummary. + :type: str + """ + self._instance_id = instance_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostVulnerabilityImpactedHostSummary. + The compartment ID of the impacted host + + + :return: The compartment_id of this HostVulnerabilityImpactedHostSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostVulnerabilityImpactedHostSummary. + The compartment ID of the impacted host + + + :param compartment_id: The compartment_id of this HostVulnerabilityImpactedHostSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def last_agent_scan_id(self): + """ + **[Required]** Gets the last_agent_scan_id of this HostVulnerabilityImpactedHostSummary. + The ID of the last host agent scan result + + + :return: The last_agent_scan_id of this HostVulnerabilityImpactedHostSummary. + :rtype: str + """ + return self._last_agent_scan_id + + @last_agent_scan_id.setter + def last_agent_scan_id(self, last_agent_scan_id): + """ + Sets the last_agent_scan_id of this HostVulnerabilityImpactedHostSummary. + The ID of the last host agent scan result + + + :param last_agent_scan_id: The last_agent_scan_id of this HostVulnerabilityImpactedHostSummary. + :type: str + """ + self._last_agent_scan_id = last_agent_scan_id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostVulnerabilityImpactedHostSummary. + The current state of the resource. + + 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 HostVulnerabilityImpactedHostSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostVulnerabilityImpactedHostSummary. + The current state of the resource. + + + :param lifecycle_state: The lifecycle_state of this HostVulnerabilityImpactedHostSummary. + :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 + + 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/vulnerability_scanning/models/host_vulnerability_impacted_host_summary_collection.py b/src/oci/vulnerability_scanning/models/host_vulnerability_impacted_host_summary_collection.py new file mode 100644 index 0000000000..af5e73c319 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_vulnerability_impacted_host_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostVulnerabilityImpactedHostSummaryCollection(object): + """ + A collection of HostVulnerabilityImpactedHost + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostVulnerabilityImpactedHostSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostVulnerabilityImpactedHostSummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary] + + """ + self.swagger_types = { + 'items': 'list[HostVulnerabilityImpactedHostSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostVulnerabilityImpactedHostSummaryCollection. + The ImpactedHostSummary objects in the collection + + + :return: The items of this HostVulnerabilityImpactedHostSummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostVulnerabilityImpactedHostSummaryCollection. + The ImpactedHostSummary objects in the collection + + + :param items: The items of this HostVulnerabilityImpactedHostSummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummary] + """ + self._items = items + + 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/vulnerability_scanning/models/host_vulnerability_summary.py b/src/oci/vulnerability_scanning/models/host_vulnerability_summary.py new file mode 100644 index 0000000000..c77616024a --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_vulnerability_summary.py @@ -0,0 +1,476 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostVulnerabilitySummary(object): + """ + Summary of a host scan vulnerability + """ + + #: A constant which can be used with the severity property of a HostVulnerabilitySummary. + #: This constant has a value of "NONE" + SEVERITY_NONE = "NONE" + + #: A constant which can be used with the severity property of a HostVulnerabilitySummary. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a HostVulnerabilitySummary. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a HostVulnerabilitySummary. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a HostVulnerabilitySummary. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the state property of a HostVulnerabilitySummary. + #: This constant has a value of "OPEN" + STATE_OPEN = "OPEN" + + #: A constant which can be used with the state property of a HostVulnerabilitySummary. + #: This constant has a value of "FIXED" + STATE_FIXED = "FIXED" + + #: A constant which can be used with the state property of a HostVulnerabilitySummary. + #: This constant has a value of "NOT_APPLICABLE" + STATE_NOT_APPLICABLE = "NOT_APPLICABLE" + + #: A constant which can be used with the vulnerability_type property of a HostVulnerabilitySummary. + #: This constant has a value of "CVE" + VULNERABILITY_TYPE_CVE = "CVE" + + #: A constant which can be used with the vulnerability_type property of a HostVulnerabilitySummary. + #: This constant has a value of "PROBLEM" + VULNERABILITY_TYPE_PROBLEM = "PROBLEM" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a HostVulnerabilitySummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new HostVulnerabilitySummary 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 HostVulnerabilitySummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this HostVulnerabilitySummary. + :type compartment_id: str + + :param cve_reference: + The value to assign to the cve_reference property of this HostVulnerabilitySummary. + :type cve_reference: str + + :param severity: + The value to assign to the severity property of this HostVulnerabilitySummary. + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param state: + The value to assign to the state property of this HostVulnerabilitySummary. + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + :param name: + The value to assign to the name property of this HostVulnerabilitySummary. + :type name: str + + :param time_last_detected: + The value to assign to the time_last_detected property of this HostVulnerabilitySummary. + :type time_last_detected: datetime + + :param time_first_detected: + The value to assign to the time_first_detected property of this HostVulnerabilitySummary. + :type time_first_detected: datetime + + :param host_count: + The value to assign to the host_count property of this HostVulnerabilitySummary. + :type host_count: int + + :param vulnerability_type: + The value to assign to the vulnerability_type property of this HostVulnerabilitySummary. + Allowed values for this property are: "CVE", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type vulnerability_type: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this HostVulnerabilitySummary. + 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 + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'cve_reference': 'str', + 'severity': 'str', + 'state': 'str', + 'name': 'str', + 'time_last_detected': 'datetime', + 'time_first_detected': 'datetime', + 'host_count': 'int', + 'vulnerability_type': 'str', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'cve_reference': 'cveReference', + 'severity': 'severity', + 'state': 'state', + 'name': 'name', + 'time_last_detected': 'timeLastDetected', + 'time_first_detected': 'timeFirstDetected', + 'host_count': 'hostCount', + 'vulnerability_type': 'vulnerabilityType', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._compartment_id = None + self._cve_reference = None + self._severity = None + self._state = None + self._name = None + self._time_last_detected = None + self._time_first_detected = None + self._host_count = None + self._vulnerability_type = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this HostVulnerabilitySummary. + ID of the vulnerability + + + :return: The id of this HostVulnerabilitySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HostVulnerabilitySummary. + ID of the vulnerability + + + :param id: The id of this HostVulnerabilitySummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostVulnerabilitySummary. + Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments. + + + :return: The compartment_id of this HostVulnerabilitySummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostVulnerabilitySummary. + Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments. + + + :param compartment_id: The compartment_id of this HostVulnerabilitySummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def cve_reference(self): + """ + Gets the cve_reference of this HostVulnerabilitySummary. + Reference to MITRE CVE ID + + + :return: The cve_reference of this HostVulnerabilitySummary. + :rtype: str + """ + return self._cve_reference + + @cve_reference.setter + def cve_reference(self, cve_reference): + """ + Sets the cve_reference of this HostVulnerabilitySummary. + Reference to MITRE CVE ID + + + :param cve_reference: The cve_reference of this HostVulnerabilitySummary. + :type: str + """ + self._cve_reference = cve_reference + + @property + def severity(self): + """ + **[Required]** Gets the severity of this HostVulnerabilitySummary. + Severity of the vulnerability + + Allowed values for this property are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this HostVulnerabilitySummary. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this HostVulnerabilitySummary. + Severity of the vulnerability + + + :param severity: The severity of this HostVulnerabilitySummary. + :type: str + """ + allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def state(self): + """ + Gets the state of this HostVulnerabilitySummary. + State of the vulnerability + + Allowed values for this property are: "OPEN", "FIXED", "NOT_APPLICABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this HostVulnerabilitySummary. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this HostVulnerabilitySummary. + State of the vulnerability + + + :param state: The state of this HostVulnerabilitySummary. + :type: str + """ + allowed_values = ["OPEN", "FIXED", "NOT_APPLICABLE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = state + + @property + def name(self): + """ + **[Required]** Gets the name of this HostVulnerabilitySummary. + Vulnerability name + + + :return: The name of this HostVulnerabilitySummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HostVulnerabilitySummary. + Vulnerability name + + + :param name: The name of this HostVulnerabilitySummary. + :type: str + """ + self._name = name + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this HostVulnerabilitySummary. + Date of scan result that most recently reported the vulnerability + + + :return: The time_last_detected of this HostVulnerabilitySummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this HostVulnerabilitySummary. + Date of scan result that most recently reported the vulnerability + + + :param time_last_detected: The time_last_detected of this HostVulnerabilitySummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this HostVulnerabilitySummary. + Date of scan result that first reported the vulnerability + + + :return: The time_first_detected of this HostVulnerabilitySummary. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this HostVulnerabilitySummary. + Date of scan result that first reported the vulnerability + + + :param time_first_detected: The time_first_detected of this HostVulnerabilitySummary. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def host_count(self): + """ + **[Required]** Gets the host_count of this HostVulnerabilitySummary. + Number of scanned hosts in this compartment whose scan results currently report this vulnerability + + + :return: The host_count of this HostVulnerabilitySummary. + :rtype: int + """ + return self._host_count + + @host_count.setter + def host_count(self, host_count): + """ + Sets the host_count of this HostVulnerabilitySummary. + Number of scanned hosts in this compartment whose scan results currently report this vulnerability + + + :param host_count: The host_count of this HostVulnerabilitySummary. + :type: int + """ + self._host_count = host_count + + @property + def vulnerability_type(self): + """ + **[Required]** Gets the vulnerability_type of this HostVulnerabilitySummary. + Specifies the type of Vulnerability + + Allowed values for this property are: "CVE", "PROBLEM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The vulnerability_type of this HostVulnerabilitySummary. + :rtype: str + """ + return self._vulnerability_type + + @vulnerability_type.setter + def vulnerability_type(self, vulnerability_type): + """ + Sets the vulnerability_type of this HostVulnerabilitySummary. + Specifies the type of Vulnerability + + + :param vulnerability_type: The vulnerability_type of this HostVulnerabilitySummary. + :type: str + """ + allowed_values = ["CVE", "PROBLEM"] + if not value_allowed_none_or_none_sentinel(vulnerability_type, allowed_values): + vulnerability_type = 'UNKNOWN_ENUM_VALUE' + self._vulnerability_type = vulnerability_type + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this HostVulnerabilitySummary. + The current state of the resource. + + 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 HostVulnerabilitySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this HostVulnerabilitySummary. + The current state of the resource. + + + :param lifecycle_state: The lifecycle_state of this HostVulnerabilitySummary. + :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 + + 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/vulnerability_scanning/models/host_vulnerability_summary_collection.py b/src/oci/vulnerability_scanning/models/host_vulnerability_summary_collection.py new file mode 100644 index 0000000000..4a8e652f87 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/host_vulnerability_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostVulnerabilitySummaryCollection(object): + """ + A collection of HostVulnerabilitySummary + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostVulnerabilitySummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this HostVulnerabilitySummaryCollection. + :type items: list[oci.vulnerability_scanning.models.HostVulnerabilitySummary] + + """ + self.swagger_types = { + 'items': 'list[HostVulnerabilitySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this HostVulnerabilitySummaryCollection. + The HostVulnerabilitySummary objects in the collection + + + :return: The items of this HostVulnerabilitySummaryCollection. + :rtype: list[oci.vulnerability_scanning.models.HostVulnerabilitySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this HostVulnerabilitySummaryCollection. + The HostVulnerabilitySummary objects in the collection + + + :param items: The items of this HostVulnerabilitySummaryCollection. + :type: list[oci.vulnerability_scanning.models.HostVulnerabilitySummary] + """ + self._items = items + + 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/vulnerability_scanning/models/ocir_container_scan_registry.py b/src/oci/vulnerability_scanning/models/ocir_container_scan_registry.py new file mode 100644 index 0000000000..36e2b2dd14 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/ocir_container_scan_registry.py @@ -0,0 +1,122 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .container_scan_registry import ContainerScanRegistry +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 OcirContainerScanRegistry(ContainerScanRegistry): + """ + Registry information for a OCI Registry target + """ + + def __init__(self, **kwargs): + """ + Initializes a new OcirContainerScanRegistry object with values from keyword arguments. The default value of the :py:attr:`~oci.vulnerability_scanning.models.OcirContainerScanRegistry.type` attribute + of this class is ``OCIR`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this OcirContainerScanRegistry. + Allowed values for this property are: "OCIR" + :type type: str + + :param url: + The value to assign to the url property of this OcirContainerScanRegistry. + :type url: str + + :param compartment_id: + The value to assign to the compartment_id property of this OcirContainerScanRegistry. + :type compartment_id: str + + :param repositories: + The value to assign to the repositories property of this OcirContainerScanRegistry. + :type repositories: list[str] + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str', + 'compartment_id': 'str', + 'repositories': 'list[str]' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url', + 'compartment_id': 'compartmentId', + 'repositories': 'repositories' + } + + self._type = None + self._url = None + self._compartment_id = None + self._repositories = None + self._type = 'OCIR' + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this OcirContainerScanRegistry. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this OcirContainerScanRegistry. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this OcirContainerScanRegistry. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this OcirContainerScanRegistry. + :type: str + """ + self._compartment_id = compartment_id + + @property + def repositories(self): + """ + Gets the repositories of this OcirContainerScanRegistry. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :return: The repositories of this OcirContainerScanRegistry. + :rtype: list[str] + """ + return self._repositories + + @repositories.setter + def repositories(self, repositories): + """ + Sets the repositories of this OcirContainerScanRegistry. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :param repositories: The repositories of this OcirContainerScanRegistry. + :type: list[str] + """ + self._repositories = repositories + + 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/vulnerability_scanning/models/schedule.py b/src/oci/vulnerability_scanning/models/schedule.py new file mode 100644 index 0000000000..3da56cca83 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/schedule.py @@ -0,0 +1,153 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Schedule(object): + """ + A scanning schedule + """ + + #: A constant which can be used with the type property of a Schedule. + #: This constant has a value of "DAILY" + TYPE_DAILY = "DAILY" + + #: A constant which can be used with the type property of a Schedule. + #: This constant has a value of "WEEKLY" + TYPE_WEEKLY = "WEEKLY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "SUNDAY" + DAY_OF_WEEK_SUNDAY = "SUNDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "MONDAY" + DAY_OF_WEEK_MONDAY = "MONDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "TUESDAY" + DAY_OF_WEEK_TUESDAY = "TUESDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "WEDNESDAY" + DAY_OF_WEEK_WEDNESDAY = "WEDNESDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "THURSDAY" + DAY_OF_WEEK_THURSDAY = "THURSDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "FRIDAY" + DAY_OF_WEEK_FRIDAY = "FRIDAY" + + #: A constant which can be used with the day_of_week property of a Schedule. + #: This constant has a value of "SATURDAY" + DAY_OF_WEEK_SATURDAY = "SATURDAY" + + def __init__(self, **kwargs): + """ + Initializes a new Schedule object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this Schedule. + Allowed values for this property are: "DAILY", "WEEKLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param day_of_week: + The value to assign to the day_of_week property of this Schedule. + Allowed values for this property are: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type day_of_week: str + + """ + self.swagger_types = { + 'type': 'str', + 'day_of_week': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'day_of_week': 'dayOfWeek' + } + + self._type = None + self._day_of_week = None + + @property + def type(self): + """ + **[Required]** Gets the type of this Schedule. + How often the scan occurs + + Allowed values for this property are: "DAILY", "WEEKLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this Schedule. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Schedule. + How often the scan occurs + + + :param type: The type of this Schedule. + :type: str + """ + allowed_values = ["DAILY", "WEEKLY"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def day_of_week(self): + """ + Gets the day_of_week of this Schedule. + Day of week the scheduled scan occurs (not applicable for DAILY type) + + Allowed values for this property are: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The day_of_week of this Schedule. + :rtype: str + """ + return self._day_of_week + + @day_of_week.setter + def day_of_week(self, day_of_week): + """ + Sets the day_of_week of this Schedule. + Day of week the scheduled scan occurs (not applicable for DAILY type) + + + :param day_of_week: The day_of_week of this Schedule. + :type: str + """ + allowed_values = ["SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"] + if not value_allowed_none_or_none_sentinel(day_of_week, allowed_values): + day_of_week = 'UNKNOWN_ENUM_VALUE' + self._day_of_week = day_of_week + + 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/vulnerability_scanning/models/update_container_scan_recipe_details.py b/src/oci/vulnerability_scanning/models/update_container_scan_recipe_details.py new file mode 100644 index 0000000000..95420672ac --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_container_scan_recipe_details.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateContainerScanRecipeDetails(object): + """ + The information to update an existing container scan recipe + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateContainerScanRecipeDetails 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 UpdateContainerScanRecipeDetails. + :type display_name: str + + :param scan_settings: + The value to assign to the scan_settings property of this UpdateContainerScanRecipeDetails. + :type scan_settings: oci.vulnerability_scanning.models.ContainerScanSettings + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateContainerScanRecipeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateContainerScanRecipeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'scan_settings': 'ContainerScanSettings', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'scan_settings': 'scanSettings', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._scan_settings = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateContainerScanRecipeDetails. + User friendly name of container scan recipe + + + :return: The display_name of this UpdateContainerScanRecipeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateContainerScanRecipeDetails. + User friendly name of container scan recipe + + + :param display_name: The display_name of this UpdateContainerScanRecipeDetails. + :type: str + """ + self._display_name = display_name + + @property + def scan_settings(self): + """ + Gets the scan_settings of this UpdateContainerScanRecipeDetails. + + :return: The scan_settings of this UpdateContainerScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.ContainerScanSettings + """ + return self._scan_settings + + @scan_settings.setter + def scan_settings(self, scan_settings): + """ + Sets the scan_settings of this UpdateContainerScanRecipeDetails. + + :param scan_settings: The scan_settings of this UpdateContainerScanRecipeDetails. + :type: oci.vulnerability_scanning.models.ContainerScanSettings + """ + self._scan_settings = scan_settings + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateContainerScanRecipeDetails. + 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 UpdateContainerScanRecipeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateContainerScanRecipeDetails. + 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 UpdateContainerScanRecipeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateContainerScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateContainerScanRecipeDetails. + :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 UpdateContainerScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateContainerScanRecipeDetails. + :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/vulnerability_scanning/models/update_container_scan_registry_details.py b/src/oci/vulnerability_scanning/models/update_container_scan_registry_details.py new file mode 100644 index 0000000000..9349538bfc --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_container_scan_registry_details.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateContainerScanRegistryDetails(object): + """ + Registry information for a container scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateContainerScanRegistryDetails 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.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this UpdateContainerScanRegistryDetails. + :type type: str + + :param url: + The value to assign to the url property of this UpdateContainerScanRegistryDetails. + :type url: str + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url' + } + + self._type = None + self._url = 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['type'] + + if type == 'OCIR': + return 'UpdateOcirContainerScanRegistryDetails' + else: + return 'UpdateContainerScanRegistryDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this UpdateContainerScanRegistryDetails. + The scan level + + + :return: The type of this UpdateContainerScanRegistryDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this UpdateContainerScanRegistryDetails. + The scan level + + + :param type: The type of this UpdateContainerScanRegistryDetails. + :type: str + """ + self._type = type + + @property + def url(self): + """ + Gets the url of this UpdateContainerScanRegistryDetails. + URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). If null, will not be updated. + + + :return: The url of this UpdateContainerScanRegistryDetails. + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """ + Sets the url of this UpdateContainerScanRegistryDetails. + URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). If null, will not be updated. + + + :param url: The url of this UpdateContainerScanRegistryDetails. + :type: str + """ + self._url = url + + 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/vulnerability_scanning/models/update_container_scan_target_details.py b/src/oci/vulnerability_scanning/models/update_container_scan_target_details.py new file mode 100644 index 0000000000..f8d641ade3 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_container_scan_target_details.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateContainerScanTargetDetails(object): + """ + The information to update an existing container scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateContainerScanTargetDetails 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 UpdateContainerScanTargetDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateContainerScanTargetDetails. + :type description: str + + :param target_registry: + The value to assign to the target_registry property of this UpdateContainerScanTargetDetails. + :type target_registry: oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails + + :param container_scan_recipe_id: + The value to assign to the container_scan_recipe_id property of this UpdateContainerScanTargetDetails. + :type container_scan_recipe_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateContainerScanTargetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateContainerScanTargetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'target_registry': 'UpdateContainerScanRegistryDetails', + 'container_scan_recipe_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'target_registry': 'targetRegistry', + 'container_scan_recipe_id': 'containerScanRecipeId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._target_registry = None + self._container_scan_recipe_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateContainerScanTargetDetails. + User friendly name of container scan target + + + :return: The display_name of this UpdateContainerScanTargetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateContainerScanTargetDetails. + User friendly name of container scan target + + + :param display_name: The display_name of this UpdateContainerScanTargetDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateContainerScanTargetDetails. + Target description. + + + :return: The description of this UpdateContainerScanTargetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateContainerScanTargetDetails. + Target description. + + + :param description: The description of this UpdateContainerScanTargetDetails. + :type: str + """ + self._description = description + + @property + def target_registry(self): + """ + Gets the target_registry of this UpdateContainerScanTargetDetails. + + :return: The target_registry of this UpdateContainerScanTargetDetails. + :rtype: oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails + """ + return self._target_registry + + @target_registry.setter + def target_registry(self, target_registry): + """ + Sets the target_registry of this UpdateContainerScanTargetDetails. + + :param target_registry: The target_registry of this UpdateContainerScanTargetDetails. + :type: oci.vulnerability_scanning.models.UpdateContainerScanRegistryDetails + """ + self._target_registry = target_registry + + @property + def container_scan_recipe_id(self): + """ + Gets the container_scan_recipe_id of this UpdateContainerScanTargetDetails. + ID of the container scan recipe this target applies. + + + :return: The container_scan_recipe_id of this UpdateContainerScanTargetDetails. + :rtype: str + """ + return self._container_scan_recipe_id + + @container_scan_recipe_id.setter + def container_scan_recipe_id(self, container_scan_recipe_id): + """ + Sets the container_scan_recipe_id of this UpdateContainerScanTargetDetails. + ID of the container scan recipe this target applies. + + + :param container_scan_recipe_id: The container_scan_recipe_id of this UpdateContainerScanTargetDetails. + :type: str + """ + self._container_scan_recipe_id = container_scan_recipe_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateContainerScanTargetDetails. + 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 UpdateContainerScanTargetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateContainerScanTargetDetails. + 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 UpdateContainerScanTargetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateContainerScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateContainerScanTargetDetails. + :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 UpdateContainerScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateContainerScanTargetDetails. + :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/vulnerability_scanning/models/update_host_scan_recipe_details.py b/src/oci/vulnerability_scanning/models/update_host_scan_recipe_details.py new file mode 100644 index 0000000000..fcc64783b2 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_host_scan_recipe_details.py @@ -0,0 +1,217 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateHostScanRecipeDetails(object): + """ + The information to update an existing host scan recipe + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateHostScanRecipeDetails 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 UpdateHostScanRecipeDetails. + :type display_name: str + + :param port_settings: + The value to assign to the port_settings property of this UpdateHostScanRecipeDetails. + :type port_settings: oci.vulnerability_scanning.models.HostScanPortSettings + + :param agent_settings: + The value to assign to the agent_settings property of this UpdateHostScanRecipeDetails. + :type agent_settings: oci.vulnerability_scanning.models.HostScanAgentSettings + + :param schedule: + The value to assign to the schedule property of this UpdateHostScanRecipeDetails. + :type schedule: oci.vulnerability_scanning.models.Schedule + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateHostScanRecipeDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateHostScanRecipeDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'port_settings': 'HostScanPortSettings', + 'agent_settings': 'HostScanAgentSettings', + 'schedule': 'Schedule', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'port_settings': 'portSettings', + 'agent_settings': 'agentSettings', + 'schedule': 'schedule', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._port_settings = None + self._agent_settings = None + self._schedule = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateHostScanRecipeDetails. + Recipe identifier, which can be renamed. Avoid entering confidential information. + + + :return: The display_name of this UpdateHostScanRecipeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateHostScanRecipeDetails. + Recipe identifier, which can be renamed. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateHostScanRecipeDetails. + :type: str + """ + self._display_name = display_name + + @property + def port_settings(self): + """ + Gets the port_settings of this UpdateHostScanRecipeDetails. + + :return: The port_settings of this UpdateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.HostScanPortSettings + """ + return self._port_settings + + @port_settings.setter + def port_settings(self, port_settings): + """ + Sets the port_settings of this UpdateHostScanRecipeDetails. + + :param port_settings: The port_settings of this UpdateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.HostScanPortSettings + """ + self._port_settings = port_settings + + @property + def agent_settings(self): + """ + Gets the agent_settings of this UpdateHostScanRecipeDetails. + + :return: The agent_settings of this UpdateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + return self._agent_settings + + @agent_settings.setter + def agent_settings(self, agent_settings): + """ + Sets the agent_settings of this UpdateHostScanRecipeDetails. + + :param agent_settings: The agent_settings of this UpdateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.HostScanAgentSettings + """ + self._agent_settings = agent_settings + + @property + def schedule(self): + """ + Gets the schedule of this UpdateHostScanRecipeDetails. + + :return: The schedule of this UpdateHostScanRecipeDetails. + :rtype: oci.vulnerability_scanning.models.Schedule + """ + return self._schedule + + @schedule.setter + def schedule(self, schedule): + """ + Sets the schedule of this UpdateHostScanRecipeDetails. + + :param schedule: The schedule of this UpdateHostScanRecipeDetails. + :type: oci.vulnerability_scanning.models.Schedule + """ + self._schedule = schedule + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateHostScanRecipeDetails. + 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 UpdateHostScanRecipeDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateHostScanRecipeDetails. + 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 UpdateHostScanRecipeDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateHostScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateHostScanRecipeDetails. + :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 UpdateHostScanRecipeDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateHostScanRecipeDetails. + :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/vulnerability_scanning/models/update_host_scan_target_details.py b/src/oci/vulnerability_scanning/models/update_host_scan_target_details.py new file mode 100644 index 0000000000..967256180d --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_host_scan_target_details.py @@ -0,0 +1,260 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateHostScanTargetDetails(object): + """ + The information to update an existing host scan target + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateHostScanTargetDetails 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 UpdateHostScanTargetDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateHostScanTargetDetails. + :type description: str + + :param target_compartment_id: + The value to assign to the target_compartment_id property of this UpdateHostScanTargetDetails. + :type target_compartment_id: str + + :param instance_ids: + The value to assign to the instance_ids property of this UpdateHostScanTargetDetails. + :type instance_ids: list[str] + + :param host_scan_recipe_id: + The value to assign to the host_scan_recipe_id property of this UpdateHostScanTargetDetails. + :type host_scan_recipe_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateHostScanTargetDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateHostScanTargetDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'target_compartment_id': 'str', + 'instance_ids': 'list[str]', + 'host_scan_recipe_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'target_compartment_id': 'targetCompartmentId', + 'instance_ids': 'instanceIds', + 'host_scan_recipe_id': 'hostScanRecipeId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._target_compartment_id = None + self._instance_ids = None + self._host_scan_recipe_id = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateHostScanTargetDetails. + Target identifier, which can be renamed. Avoid entering confidential information. + + + :return: The display_name of this UpdateHostScanTargetDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateHostScanTargetDetails. + Target identifier, which can be renamed. Avoid entering confidential information. + + + :param display_name: The display_name of this UpdateHostScanTargetDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateHostScanTargetDetails. + Target description. + + + :return: The description of this UpdateHostScanTargetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateHostScanTargetDetails. + Target description. + + + :param description: The description of this UpdateHostScanTargetDetails. + :type: str + """ + self._description = description + + @property + def target_compartment_id(self): + """ + Gets the target_compartment_id of this UpdateHostScanTargetDetails. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :return: The target_compartment_id of this UpdateHostScanTargetDetails. + :rtype: str + """ + return self._target_compartment_id + + @target_compartment_id.setter + def target_compartment_id(self, target_compartment_id): + """ + Sets the target_compartment_id of this UpdateHostScanTargetDetails. + Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. + + + :param target_compartment_id: The target_compartment_id of this UpdateHostScanTargetDetails. + :type: str + """ + self._target_compartment_id = target_compartment_id + + @property + def instance_ids(self): + """ + Gets the instance_ids of this UpdateHostScanTargetDetails. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :return: The instance_ids of this UpdateHostScanTargetDetails. + :rtype: list[str] + """ + return self._instance_ids + + @instance_ids.setter + def instance_ids(self, instance_ids): + """ + Sets the instance_ids of this UpdateHostScanTargetDetails. + List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. + + + :param instance_ids: The instance_ids of this UpdateHostScanTargetDetails. + :type: list[str] + """ + self._instance_ids = instance_ids + + @property + def host_scan_recipe_id(self): + """ + Gets the host_scan_recipe_id of this UpdateHostScanTargetDetails. + ID of the host scan recipe this target applies. + + + :return: The host_scan_recipe_id of this UpdateHostScanTargetDetails. + :rtype: str + """ + return self._host_scan_recipe_id + + @host_scan_recipe_id.setter + def host_scan_recipe_id(self, host_scan_recipe_id): + """ + Sets the host_scan_recipe_id of this UpdateHostScanTargetDetails. + ID of the host scan recipe this target applies. + + + :param host_scan_recipe_id: The host_scan_recipe_id of this UpdateHostScanTargetDetails. + :type: str + """ + self._host_scan_recipe_id = host_scan_recipe_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateHostScanTargetDetails. + 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 UpdateHostScanTargetDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateHostScanTargetDetails. + 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 UpdateHostScanTargetDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateHostScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateHostScanTargetDetails. + :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 UpdateHostScanTargetDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateHostScanTargetDetails. + :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/vulnerability_scanning/models/update_ocir_container_scan_registry_details.py b/src/oci/vulnerability_scanning/models/update_ocir_container_scan_registry_details.py new file mode 100644 index 0000000000..1f2b6e5abe --- /dev/null +++ b/src/oci/vulnerability_scanning/models/update_ocir_container_scan_registry_details.py @@ -0,0 +1,121 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .update_container_scan_registry_details import UpdateContainerScanRegistryDetails +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 UpdateOcirContainerScanRegistryDetails(UpdateContainerScanRegistryDetails): + """ + Registry information for a OCI Registry target + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateOcirContainerScanRegistryDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.vulnerability_scanning.models.UpdateOcirContainerScanRegistryDetails.type` attribute + of this class is ``OCIR`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this UpdateOcirContainerScanRegistryDetails. + :type type: str + + :param url: + The value to assign to the url property of this UpdateOcirContainerScanRegistryDetails. + :type url: str + + :param compartment_id: + The value to assign to the compartment_id property of this UpdateOcirContainerScanRegistryDetails. + :type compartment_id: str + + :param repositories: + The value to assign to the repositories property of this UpdateOcirContainerScanRegistryDetails. + :type repositories: list[str] + + """ + self.swagger_types = { + 'type': 'str', + 'url': 'str', + 'compartment_id': 'str', + 'repositories': 'list[str]' + } + + self.attribute_map = { + 'type': 'type', + 'url': 'url', + 'compartment_id': 'compartmentId', + 'repositories': 'repositories' + } + + self._type = None + self._url = None + self._compartment_id = None + self._repositories = None + self._type = 'OCIR' + + @property + def compartment_id(self): + """ + Gets the compartment_id of this UpdateOcirContainerScanRegistryDetails. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this UpdateOcirContainerScanRegistryDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this UpdateOcirContainerScanRegistryDetails. + The `OCID`__ of the compartment to perform the scans in. All listed repositories must be in the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this UpdateOcirContainerScanRegistryDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def repositories(self): + """ + Gets the repositories of this UpdateOcirContainerScanRegistryDetails. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :return: The repositories of this UpdateOcirContainerScanRegistryDetails. + :rtype: list[str] + """ + return self._repositories + + @repositories.setter + def repositories(self, repositories): + """ + Sets the repositories of this UpdateOcirContainerScanRegistryDetails. + List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId + + + :param repositories: The repositories of this UpdateOcirContainerScanRegistryDetails. + :type: list[str] + """ + self._repositories = repositories + + 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/vulnerability_scanning/models/work_request.py b/src/oci/vulnerability_scanning/models/work_request.py new file mode 100644 index 0000000000..d2eb2f32f5 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request.py @@ -0,0 +1,420 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequest(object): + """ + A description of workrequest status + """ + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_HOST_SCAN_RECIPE" + OPERATION_TYPE_CREATE_HOST_SCAN_RECIPE = "CREATE_HOST_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_HOST_SCAN_RECIPE" + OPERATION_TYPE_UPDATE_HOST_SCAN_RECIPE = "UPDATE_HOST_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_HOST_SCAN_RECIPE" + OPERATION_TYPE_DELETE_HOST_SCAN_RECIPE = "DELETE_HOST_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_HOST_SCAN_TARGET" + OPERATION_TYPE_CREATE_HOST_SCAN_TARGET = "CREATE_HOST_SCAN_TARGET" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_HOST_SCAN_TARGET" + OPERATION_TYPE_UPDATE_HOST_SCAN_TARGET = "UPDATE_HOST_SCAN_TARGET" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_HOST_SCAN_TARGET" + OPERATION_TYPE_DELETE_HOST_SCAN_TARGET = "DELETE_HOST_SCAN_TARGET" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_CONTAINER_SCAN_RECIPE" + OPERATION_TYPE_CREATE_CONTAINER_SCAN_RECIPE = "CREATE_CONTAINER_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_CONTAINER_SCAN_RECIPE" + OPERATION_TYPE_UPDATE_CONTAINER_SCAN_RECIPE = "UPDATE_CONTAINER_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_CONTAINER_SCAN_RECIPE" + OPERATION_TYPE_DELETE_CONTAINER_SCAN_RECIPE = "DELETE_CONTAINER_SCAN_RECIPE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_CONTAINER_SCAN_TARGET" + OPERATION_TYPE_CREATE_CONTAINER_SCAN_TARGET = "CREATE_CONTAINER_SCAN_TARGET" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_CONTAINER_SCAN_TARGET" + OPERATION_TYPE_UPDATE_CONTAINER_SCAN_TARGET = "UPDATE_CONTAINER_SCAN_TARGET" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_CONTAINER_SCAN_TARGET" + OPERATION_TYPE_DELETE_CONTAINER_SCAN_TARGET = "DELETE_CONTAINER_SCAN_TARGET" + + #: 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" + + 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_HOST_SCAN_RECIPE", "UPDATE_HOST_SCAN_RECIPE", "DELETE_HOST_SCAN_RECIPE", "CREATE_HOST_SCAN_TARGET", "UPDATE_HOST_SCAN_TARGET", "DELETE_HOST_SCAN_TARGET", "CREATE_CONTAINER_SCAN_RECIPE", "UPDATE_CONTAINER_SCAN_RECIPE", "DELETE_CONTAINER_SCAN_RECIPE", "CREATE_CONTAINER_SCAN_TARGET", "UPDATE_CONTAINER_SCAN_TARGET", "DELETE_CONTAINER_SCAN_TARGET", '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", '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[oci.vulnerability_scanning.models.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_HOST_SCAN_RECIPE", "UPDATE_HOST_SCAN_RECIPE", "DELETE_HOST_SCAN_RECIPE", "CREATE_HOST_SCAN_TARGET", "UPDATE_HOST_SCAN_TARGET", "DELETE_HOST_SCAN_TARGET", "CREATE_CONTAINER_SCAN_RECIPE", "UPDATE_CONTAINER_SCAN_RECIPE", "DELETE_CONTAINER_SCAN_RECIPE", "CREATE_CONTAINER_SCAN_TARGET", "UPDATE_CONTAINER_SCAN_TARGET", "DELETE_CONTAINER_SCAN_TARGET", '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_HOST_SCAN_RECIPE", "UPDATE_HOST_SCAN_RECIPE", "DELETE_HOST_SCAN_RECIPE", "CREATE_HOST_SCAN_TARGET", "UPDATE_HOST_SCAN_TARGET", "DELETE_HOST_SCAN_TARGET", "CREATE_CONTAINER_SCAN_RECIPE", "UPDATE_CONTAINER_SCAN_RECIPE", "DELETE_CONTAINER_SCAN_RECIPE", "CREATE_CONTAINER_SCAN_TARGET", "UPDATE_CONTAINER_SCAN_TARGET", "DELETE_CONTAINER_SCAN_TARGET"] + 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", '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"] + 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[oci.vulnerability_scanning.models.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[oci.vulnerability_scanning.models.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/vulnerability_scanning/models/work_request_collection.py b/src/oci/vulnerability_scanning/models/work_request_collection.py new file mode 100644 index 0000000000..9047f43a39 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestCollection(object): + """ + A collection of WorkRequest objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this WorkRequestCollection. + :type items: list[oci.vulnerability_scanning.models.WorkRequest] + + """ + self.swagger_types = { + 'items': 'list[WorkRequest]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestCollection. + The WorkRequest objects in the collection + + + :return: The items of this WorkRequestCollection. + :rtype: list[oci.vulnerability_scanning.models.WorkRequest] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestCollection. + The WorkRequest objects in the collection + + + :param items: The items of this WorkRequestCollection. + :type: list[oci.vulnerability_scanning.models.WorkRequest] + """ + self._items = items + + 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/vulnerability_scanning/models/work_request_error.py b/src/oci/vulnerability_scanning/models/work_request_error.py new file mode 100644 index 0000000000..04dde83e08 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_error.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestError(object): + """ + An error encountered while executing a 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 machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :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 description of the issue encountered. + + + :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 description of the issue encountered. + + + :param message: The message of this WorkRequestError. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestError. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :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/vulnerability_scanning/models/work_request_error_collection.py b/src/oci/vulnerability_scanning/models/work_request_error_collection.py new file mode 100644 index 0000000000..f1b71e4a5e --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_error_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestErrorCollection(object): + """ + A collection of WorkRequestError objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this WorkRequestErrorCollection. + :type items: list[oci.vulnerability_scanning.models.WorkRequestError] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestError]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestErrorCollection. + The WorkRequestError objects in the collection + + + :return: The items of this WorkRequestErrorCollection. + :rtype: list[oci.vulnerability_scanning.models.WorkRequestError] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestErrorCollection. + The WorkRequestError objects in the collection + + + :param items: The items of this WorkRequestErrorCollection. + :type: list[oci.vulnerability_scanning.models.WorkRequestError] + """ + self._items = items + + 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/vulnerability_scanning/models/work_request_log_entry.py b/src/oci/vulnerability_scanning/models/work_request_log_entry.py new file mode 100644 index 0000000000..8d02a6a994 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_log_entry.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestLogEntry(object): + """ + A log message from the execution of a 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. + Human-readable log message. + + + :return: The message of this WorkRequestLogEntry. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestLogEntry. + Human-readable log message. + + + :param message: The message of this WorkRequestLogEntry. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :return: The timestamp of this WorkRequestLogEntry. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestLogEntry. + The time the log message was written. An RFC3339 formatted datetime string + + + :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/vulnerability_scanning/models/work_request_log_entry_collection.py b/src/oci/vulnerability_scanning/models/work_request_log_entry_collection.py new file mode 100644 index 0000000000..2c166e8782 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_log_entry_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestLogEntryCollection(object): + """ + A collection of WorkRequestLogEntry objects + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogEntryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this WorkRequestLogEntryCollection. + :type items: list[oci.vulnerability_scanning.models.WorkRequestLogEntry] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestLogEntry]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestLogEntryCollection. + The WorkRequestLigEntry objects in the collection + + + :return: The items of this WorkRequestLogEntryCollection. + :rtype: list[oci.vulnerability_scanning.models.WorkRequestLogEntry] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestLogEntryCollection. + The WorkRequestLigEntry objects in the collection + + + :param items: The items of this WorkRequestLogEntryCollection. + :type: list[oci.vulnerability_scanning.models.WorkRequestLogEntry] + """ + self._items = items + + 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/vulnerability_scanning/models/work_request_resource.py b/src/oci/vulnerability_scanning/models/work_request_resource.py new file mode 100644 index 0000000000..6decbf1282 --- /dev/null +++ b/src/oci/vulnerability_scanning/models/work_request_resource.py @@ -0,0 +1,197 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class 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" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "RELATED" + ACTION_TYPE_RELATED = "RELATED" + + 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", "RELATED", '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 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 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", "RELATED", '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", "RELATED"] + 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/vulnerability_scanning/vulnerability_scanning_client.py b/src/oci/vulnerability_scanning/vulnerability_scanning_client.py new file mode 100644 index 0000000000..32065bc7cc --- /dev/null +++ b/src/oci/vulnerability_scanning/vulnerability_scanning_client.py @@ -0,0 +1,5088 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __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, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import vulnerability_scanning_type_mapping +missing = Sentinel("Missing") + + +class VulnerabilityScanningClient(object): + """ + Use the Vulnerability Scanning Service (VSS) APIs to manage scan recipes, targets, and reports. + """ + + 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 values are connection timeout 10 seconds and read timeout 60 seconds. 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'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + 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': '/20210215', + 'service_endpoint_template': 'https://vss-cp-api.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False) + } + self.base_client = BaseClient("vulnerability_scanning", config, signer, vulnerability_scanning_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + + def change_container_scan_recipe_compartment(self, container_scan_recipe_id, change_container_scan_recipe_compartment_details, **kwargs): + """ + Moves a ContainerScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe identifier + + :param oci.vulnerability_scanning.models.ChangeContainerScanRecipeCompartmentDetails change_container_scan_recipe_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_container_scan_recipe_compartment API. + """ + resource_path = "/containerScanRecipes/{containerScanRecipeId}/actions/changeCompartment" + 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( + "change_container_scan_recipe_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanRecipeId": container_scan_recipe_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=change_container_scan_recipe_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_container_scan_recipe_compartment_details) + + def change_container_scan_result_compartment(self, container_scan_result_id, change_container_scan_result_compartment_details, **kwargs): + """ + Moves a ContainerScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str container_scan_result_id: (required) + unique container scan identifier + + :param oci.vulnerability_scanning.models.ChangeContainerScanResultCompartmentDetails change_container_scan_result_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_container_scan_result_compartment API. + """ + resource_path = "/containerScanResults/{containerScanResultId}/actions/changeCompartment" + 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( + "change_container_scan_result_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanResultId": container_scan_result_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=change_container_scan_result_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_container_scan_result_compartment_details) + + def change_container_scan_target_compartment(self, container_scan_target_id, change_container_scan_target_compartment_details, **kwargs): + """ + Moves a ContainerScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str container_scan_target_id: (required) + unique ContainerScanTarget identifier + + :param oci.vulnerability_scanning.models.ChangeContainerScanTargetCompartmentDetails change_container_scan_target_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_container_scan_target_compartment API. + """ + resource_path = "/containerScanTargets/{containerScanTargetId}/actions/changeCompartment" + 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( + "change_container_scan_target_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanTargetId": container_scan_target_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=change_container_scan_target_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_container_scan_target_compartment_details) + + def change_host_agent_scan_result_compartment(self, host_agent_scan_result_id, change_host_agent_scan_result_compartment_details, **kwargs): + """ + Moves a HostAgentScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_agent_scan_result_id: (required) + unique host agent scan identifier + + :param oci.vulnerability_scanning.models.ChangeHostAgentScanResultCompartmentDetails change_host_agent_scan_result_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_agent_scan_result_compartment API. + """ + resource_path = "/hostAgentScanResults/{hostAgentScanResultId}/actions/changeCompartment" + 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( + "change_host_agent_scan_result_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostAgentScanResultId": host_agent_scan_result_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=change_host_agent_scan_result_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_host_agent_scan_result_compartment_details) + + def change_host_cis_benchmark_scan_result_compartment(self, host_cis_benchmark_scan_result_id, change_host_cis_benchmark_scan_result_compartment_details, **kwargs): + """ + Moves a HostCisBenchmarkScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_cis_benchmark_scan_result_id: (required) + unique host Cis benchmark scan identifier + + :param oci.vulnerability_scanning.models.ChangeHostCisBenchmarkScanResultCompartmentDetails change_host_cis_benchmark_scan_result_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_cis_benchmark_scan_result_compartment API. + """ + resource_path = "/hostCisBenchmarkScanResults/{hostCisBenchmarkScanResultId}/actions/changeCompartment" + 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( + "change_host_cis_benchmark_scan_result_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostCisBenchmarkScanResultId": host_cis_benchmark_scan_result_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=change_host_cis_benchmark_scan_result_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_host_cis_benchmark_scan_result_compartment_details) + + def change_host_endpoint_protection_scan_result_compartment(self, host_endpoint_protection_scan_result_id, change_host_endpoint_protection_scan_result_compartment_details, **kwargs): + """ + Moves a HostEndpointProtectionScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_endpoint_protection_scan_result_id: (required) + unique host endpoint protection scan identifier + + :param oci.vulnerability_scanning.models.ChangeHostEndpointProtectionScanResultCompartmentDetails change_host_endpoint_protection_scan_result_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_endpoint_protection_scan_result_compartment API. + """ + resource_path = "/hostEndpointProtectionScanResults/{hostEndpointProtectionScanResultId}/actions/changeCompartment" + 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( + "change_host_endpoint_protection_scan_result_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostEndpointProtectionScanResultId": host_endpoint_protection_scan_result_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=change_host_endpoint_protection_scan_result_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_host_endpoint_protection_scan_result_compartment_details) + + def change_host_port_scan_result_compartment(self, host_port_scan_result_id, change_host_port_scan_result_compartment_details, **kwargs): + """ + Moves a HostPortScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_port_scan_result_id: (required) + unique host port scan identifier + + :param oci.vulnerability_scanning.models.ChangeHostPortScanResultCompartmentDetails change_host_port_scan_result_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_port_scan_result_compartment API. + """ + resource_path = "/hostPortScanResults/{hostPortScanResultId}/actions/changeCompartment" + 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( + "change_host_port_scan_result_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostPortScanResultId": host_port_scan_result_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=change_host_port_scan_result_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_host_port_scan_result_compartment_details) + + def change_host_scan_recipe_compartment(self, host_scan_recipe_id, change_host_scan_recipe_compartment_details, **kwargs): + """ + Moves a HostScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe identifier + + :param oci.vulnerability_scanning.models.ChangeHostScanRecipeCompartmentDetails change_host_scan_recipe_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_scan_recipe_compartment API. + """ + resource_path = "/hostScanRecipes/{hostScanRecipeId}/actions/changeCompartment" + 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( + "change_host_scan_recipe_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanRecipeId": host_scan_recipe_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=change_host_scan_recipe_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_host_scan_recipe_compartment_details) + + def change_host_scan_target_compartment(self, host_scan_target_id, change_host_scan_target_compartment_details, **kwargs): + """ + Moves a HostScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource. + + + :param str host_scan_target_id: (required) + unique HostScanTarget identifier + + :param oci.vulnerability_scanning.models.ChangeHostScanTargetCompartmentDetails change_host_scan_target_compartment_details: (required) + The compartment information to update. + + :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 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 obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_host_scan_target_compartment API. + """ + resource_path = "/hostScanTargets/{hostScanTargetId}/actions/changeCompartment" + 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( + "change_host_scan_target_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanTargetId": host_scan_target_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=change_host_scan_target_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_host_scan_target_compartment_details) + + def create_container_scan_recipe(self, create_container_scan_recipe_details, **kwargs): + """ + Creates a new ContainerScanRecipe + + + :param oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails create_container_scan_recipe_details: (required) + Details for the new ContainerScanRecipe + + :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 :class:`~oci.vulnerability_scanning.models.ContainerScanRecipe` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_container_scan_recipe API. + """ + resource_path = "/containerScanRecipes" + 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_container_scan_recipe 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_container_scan_recipe_details, + response_type="ContainerScanRecipe") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_container_scan_recipe_details, + response_type="ContainerScanRecipe") + + def create_container_scan_target(self, create_container_scan_target_details, **kwargs): + """ + Creates a new ContainerScanTarget + + + :param oci.vulnerability_scanning.models.CreateContainerScanTargetDetails create_container_scan_target_details: (required) + Details for the new ContainerScanTarget + + :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 :class:`~oci.vulnerability_scanning.models.ContainerScanTarget` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_container_scan_target API. + """ + resource_path = "/containerScanTargets" + 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_container_scan_target 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_container_scan_target_details, + response_type="ContainerScanTarget") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_container_scan_target_details, + response_type="ContainerScanTarget") + + def create_host_scan_recipe(self, create_host_scan_recipe_details, **kwargs): + """ + Creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan. + + + :param oci.vulnerability_scanning.models.CreateHostScanRecipeDetails create_host_scan_recipe_details: (required) + Details for the new HostScanRecipe + + :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 :class:`~oci.vulnerability_scanning.models.HostScanRecipe` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_host_scan_recipe API. + """ + resource_path = "/hostScanRecipes" + 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_host_scan_recipe 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_host_scan_recipe_details, + response_type="HostScanRecipe") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_host_scan_recipe_details, + response_type="HostScanRecipe") + + def create_host_scan_target(self, create_host_scan_target_details, **kwargs): + """ + Creates a new HostScanTarget. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. + + + :param oci.vulnerability_scanning.models.CreateHostScanTargetDetails create_host_scan_target_details: (required) + Details for the new HostScanTarget + + :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 :class:`~oci.vulnerability_scanning.models.HostScanTarget` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_host_scan_target API. + """ + resource_path = "/hostScanTargets" + 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_host_scan_target 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_host_scan_target_details, + response_type="HostScanTarget") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_host_scan_target_details, + response_type="HostScanTarget") + + def delete_container_scan_recipe(self, container_scan_recipe_id, **kwargs): + """ + Deletes the ContainerScanRecipe identified by the id + + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe 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` + + :example: + Click `here `__ to see an example of how to use delete_container_scan_recipe API. + """ + resource_path = "/containerScanRecipes/{containerScanRecipeId}" + 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_container_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanRecipeId": container_scan_recipe_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 delete_container_scan_result(self, container_scan_result_id, **kwargs): + """ + Deletes the ContainerScanResult identified by the id + + + :param str container_scan_result_id: (required) + unique container scan 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` + + :example: + Click `here `__ to see an example of how to use delete_container_scan_result API. + """ + resource_path = "/containerScanResults/{containerScanResultId}" + 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_container_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanResultId": container_scan_result_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 delete_container_scan_target(self, container_scan_target_id, **kwargs): + """ + Deletes the ContainerScanTarget identified by the id + + + :param str container_scan_target_id: (required) + unique ContainerScanTarget 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` + + :example: + Click `here `__ to see an example of how to use delete_container_scan_target API. + """ + resource_path = "/containerScanTargets/{containerScanTargetId}" + 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_container_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanTargetId": container_scan_target_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 delete_host_agent_scan_result(self, host_agent_scan_result_id, **kwargs): + """ + Removes the HostAgentScanResult identified by the host agent scan ID. + + + :param str host_agent_scan_result_id: (required) + unique host agent scan 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` + + :example: + Click `here `__ to see an example of how to use delete_host_agent_scan_result API. + """ + resource_path = "/hostAgentScanResults/{hostAgentScanResultId}" + 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_host_agent_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostAgentScanResultId": host_agent_scan_result_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 delete_host_cis_benchmark_scan_result(self, host_cis_benchmark_scan_result_id, **kwargs): + """ + Deletes the HostCisBenchmarkScanResult identified by the id + + + :param str host_cis_benchmark_scan_result_id: (required) + unique host Cis benchmark scan 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` + + :example: + Click `here `__ to see an example of how to use delete_host_cis_benchmark_scan_result API. + """ + resource_path = "/hostCisBenchmarkScanResults/{hostCisBenchmarkScanResultId}" + 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_host_cis_benchmark_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostCisBenchmarkScanResultId": host_cis_benchmark_scan_result_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 delete_host_endpoint_protection_scan_result(self, host_endpoint_protection_scan_result_id, **kwargs): + """ + Deletes the HostEndpointProtectionScanResult identified by the id + + + :param str host_endpoint_protection_scan_result_id: (required) + unique host endpoint protection scan 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` + + :example: + Click `here `__ to see an example of how to use delete_host_endpoint_protection_scan_result API. + """ + resource_path = "/hostEndpointProtectionScanResults/{hostEndpointProtectionScanResultId}" + 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_host_endpoint_protection_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostEndpointProtectionScanResultId": host_endpoint_protection_scan_result_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 delete_host_port_scan_result(self, host_port_scan_result_id, **kwargs): + """ + Removes the HostPortScanResult identified by the host port scan ID. + + + :param str host_port_scan_result_id: (required) + unique host port scan 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` + + :example: + Click `here `__ to see an example of how to use delete_host_port_scan_result API. + """ + resource_path = "/hostPortScanResults/{hostPortScanResultId}" + 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_host_port_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostPortScanResultId": host_port_scan_result_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 delete_host_scan_recipe(self, host_scan_recipe_id, **kwargs): + """ + Removes the HostScanRecipe identified by the recipe ID. + + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe 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` + + :example: + Click `here `__ to see an example of how to use delete_host_scan_recipe API. + """ + resource_path = "/hostScanRecipes/{hostScanRecipeId}" + 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_host_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanRecipeId": host_scan_recipe_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 delete_host_scan_target(self, host_scan_target_id, **kwargs): + """ + Removes the HostScanTarget identified by the target ID. + + + :param str host_scan_target_id: (required) + unique HostScanTarget 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` + + :example: + Click `here `__ to see an example of how to use delete_host_scan_target API. + """ + resource_path = "/hostScanTargets/{hostScanTargetId}" + 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_host_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanTargetId": host_scan_target_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 export_host_agent_scan_result_csv(self, export_host_agent_scan_result_csv_details, **kwargs): + """ + Exports a list of HostAgentScanResultSummary objects within a compartment and during a specified time range in CSV format. You can filter the results by problem severity. + + + :param oci.vulnerability_scanning.models.ExportHostAgentScanResultCsvDetails export_host_agent_scan_result_csv_details: (required) + Information on which scan results to export to CSV + + :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 stream + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use export_host_agent_scan_result_csv API. + """ + resource_path = "/hostAgentScanResults/actions/exportCsv" + 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( + "export_host_agent_scan_result_csv got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "text/csv", + "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=export_host_agent_scan_result_csv_details, + response_type="stream") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=export_host_agent_scan_result_csv_details, + response_type="stream") + + def export_host_vulnerability_csv(self, export_host_vulnerability_csv_details, **kwargs): + """ + Exports a list of HostVulnerabilitySummary objects in a compartment in CSV format. + + + :param oci.vulnerability_scanning.models.ExportHostVulnerabilityCsvDetails export_host_vulnerability_csv_details: (required) + Information on which scan results to export to CSV + + :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 stream + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use export_host_vulnerability_csv API. + """ + resource_path = "/hostVulnerabilities/actions/exportCsv" + 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( + "export_host_vulnerability_csv got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "text/csv", + "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=export_host_vulnerability_csv_details, + response_type="stream") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=export_host_vulnerability_csv_details, + response_type="stream") + + def get_container_scan_recipe(self, container_scan_recipe_id, **kwargs): + """ + Gets a ContainerScanRecipe by identifier + + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe 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.vulnerability_scanning.models.ContainerScanRecipe` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_container_scan_recipe API. + """ + resource_path = "/containerScanRecipes/{containerScanRecipeId}" + 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_container_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanRecipeId": container_scan_recipe_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="ContainerScanRecipe") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ContainerScanRecipe") + + def get_container_scan_result(self, container_scan_result_id, **kwargs): + """ + Returns a ContainerScanResult of the given container scan ID. + + + :param str container_scan_result_id: (required) + unique container scan 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.vulnerability_scanning.models.ContainerScanResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_container_scan_result API. + """ + resource_path = "/containerScanResults/{containerScanResultId}" + 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_container_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanResultId": container_scan_result_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="ContainerScanResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ContainerScanResult") + + def get_container_scan_target(self, container_scan_target_id, **kwargs): + """ + Gets a ContainerScanTarget by identifier + + + :param str container_scan_target_id: (required) + unique ContainerScanTarget 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.vulnerability_scanning.models.ContainerScanTarget` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_container_scan_target API. + """ + resource_path = "/containerScanTargets/{containerScanTargetId}" + 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_container_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanTargetId": container_scan_target_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="ContainerScanTarget") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ContainerScanTarget") + + def get_host_agent_scan_result(self, host_agent_scan_result_id, **kwargs): + """ + Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a list of problems detected in a specific compute instance. + + + :param str host_agent_scan_result_id: (required) + unique host agent scan 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.vulnerability_scanning.models.HostAgentScanResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_agent_scan_result API. + """ + resource_path = "/hostAgentScanResults/{hostAgentScanResultId}" + 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_host_agent_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostAgentScanResultId": host_agent_scan_result_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="HostAgentScanResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostAgentScanResult") + + def get_host_cis_benchmark_scan_result(self, host_cis_benchmark_scan_result_id, **kwargs): + """ + Returns HostCisBenchmarkScanResults for the given host CIS (Center for Internet Security) benchmark scan result ID. + + + :param str host_cis_benchmark_scan_result_id: (required) + unique host Cis benchmark scan 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.vulnerability_scanning.models.HostCisBenchmarkScanResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_cis_benchmark_scan_result API. + """ + resource_path = "/hostCisBenchmarkScanResults/{hostCisBenchmarkScanResultId}" + 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_host_cis_benchmark_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostCisBenchmarkScanResultId": host_cis_benchmark_scan_result_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="HostCisBenchmarkScanResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostCisBenchmarkScanResult") + + def get_host_endpoint_protection_scan_result(self, host_endpoint_protection_scan_result_id, **kwargs): + """ + Returns HostEndpointProtectionScanResults for the given host endpoint protection scan result ID. + + + :param str host_endpoint_protection_scan_result_id: (required) + unique host endpoint protection scan 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.vulnerability_scanning.models.HostEndpointProtectionScanResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_endpoint_protection_scan_result API. + """ + resource_path = "/hostEndpointProtectionScanResults/{hostEndpointProtectionScanResultId}" + 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_host_endpoint_protection_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostEndpointProtectionScanResultId": host_endpoint_protection_scan_result_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="HostEndpointProtectionScanResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostEndpointProtectionScanResult") + + def get_host_port_scan_result(self, host_port_scan_result_id, **kwargs): + """ + Retrieves a HostPortScanResult identified by the host port scan ID. The result includes a list of open ports that were detected in a specific compute instance. + + + :param str host_port_scan_result_id: (required) + unique host port scan 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.vulnerability_scanning.models.HostPortScanResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_port_scan_result API. + """ + resource_path = "/hostPortScanResults/{hostPortScanResultId}" + 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_host_port_scan_result got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostPortScanResultId": host_port_scan_result_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="HostPortScanResult") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostPortScanResult") + + def get_host_scan_recipe(self, host_scan_recipe_id, **kwargs): + """ + Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan. + + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe 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.vulnerability_scanning.models.HostScanRecipe` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_scan_recipe API. + """ + resource_path = "/hostScanRecipes/{hostScanRecipeId}" + 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_host_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanRecipeId": host_scan_recipe_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="HostScanRecipe") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostScanRecipe") + + def get_host_scan_target(self, host_scan_target_id, **kwargs): + """ + Retrieves a HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. + + + :param str host_scan_target_id: (required) + unique HostScanTarget 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.vulnerability_scanning.models.HostScanTarget` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_scan_target API. + """ + resource_path = "/hostScanTargets/{hostScanTargetId}" + 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_host_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanTargetId": host_scan_target_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="HostScanTarget") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostScanTarget") + + def get_host_vulnerability(self, host_vulnerability_id, **kwargs): + """ + Retrieves a HostVulnerability identified by the host vulnerability ID. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories. + + + :param str host_vulnerability_id: (required) + unique host scan vulnerability 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.vulnerability_scanning.models.HostVulnerability` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_host_vulnerability API. + """ + resource_path = "/hostVulnerabilities/{hostVulnerabilityId}" + 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_host_vulnerability got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostVulnerabilityId": host_vulnerability_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="HostVulnerability") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="HostVulnerability") + + def get_work_request(self, work_request_id, **kwargs): + """ + 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.vulnerability_scanning.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + 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_container_scan_recipes(self, compartment_id, **kwargs): + """ + Returns a list of ContainerScanRecipeSummaries + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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 :class:`~oci.vulnerability_scanning.models.ContainerScanRecipeSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_container_scan_recipes API. + """ + resource_path = "/containerScanRecipes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "lifecycle_state", + "display_name", + "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_container_scan_recipes 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, + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", 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="ContainerScanRecipeSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ContainerScanRecipeSummaryCollection") + + def list_container_scan_results(self, compartment_id, **kwargs): + """ + Returns a collection of ContainerScanResultSummary objects + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str repository: (optional) + Repository name + + :param str image: (optional) + Image name + + :param bool are_subcompartments_included: (optional) + When listing with one or more filters, whether to include subcompartments for the compartmentId being listed for. Does nothing if no filters are present in the query. + + :param str highest_problem_severity: (optional) + Parameter to filter by highestProblemSeverity for scan results + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param datetime time_started_greater_than_or_equal_to: (optional) + Date and time on or after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :param datetime time_started_less_than_or_equal_to: (optional) + Date and time on or before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :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 is descending. If no value is specified timeFinished is default. + + Allowed values are: "timeStarted", "problemCount", "highestProblemSeverity" + + :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 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.vulnerability_scanning.models.ContainerScanResultSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_container_scan_results API. + """ + resource_path = "/containerScanResults" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "repository", + "image", + "are_subcompartments_included", + "highest_problem_severity", + "time_started_greater_than_or_equal_to", + "time_started_less_than_or_equal_to", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_container_scan_results got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'highest_problem_severity' in kwargs: + highest_problem_severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['highest_problem_severity'] not in highest_problem_severity_allowed_values: + raise ValueError( + "Invalid value for `highest_problem_severity`, must be one of {0}".format(highest_problem_severity_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 = ["timeStarted", "problemCount", "highestProblemSeverity"] + 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, + "repository": kwargs.get("repository", missing), + "image": kwargs.get("image", missing), + "areSubcompartmentsIncluded": kwargs.get("are_subcompartments_included", missing), + "highestProblemSeverity": kwargs.get("highest_problem_severity", missing), + "timeStartedGreaterThanOrEqualTo": kwargs.get("time_started_greater_than_or_equal_to", missing), + "timeStartedLessThanOrEqualTo": kwargs.get("time_started_less_than_or_equal_to", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "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, + query_params=query_params, + header_params=header_params, + response_type="ContainerScanResultSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ContainerScanResultSummaryCollection") + + def list_container_scan_targets(self, compartment_id, **kwargs): + """ + Returns a list of ContainerScanTargetSummaries + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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 :class:`~oci.vulnerability_scanning.models.ContainerScanTargetSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_container_scan_targets API. + """ + resource_path = "/containerScanTargets" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "lifecycle_state", + "display_name", + "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_container_scan_targets 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, + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", 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="ContainerScanTargetSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ContainerScanTargetSummaryCollection") + + def list_host_agent_scan_results(self, compartment_id, **kwargs): + """ + Retrieves a list of HostAgentScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. An agent scan result includes a list of problems detected in a specific compute instance. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str instance_id: (optional) + The ID of a compute instance + + :param str highest_problem_severity: (optional) + Parameter to filter by highestProblemSeverity for scan results + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param str operating_system: (optional) + Parameter to filter by operating system for scan results + + :param datetime time_started_greater_than_or_equal_to: (optional) + Date and time on or after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :param datetime time_started_less_than_or_equal_to: (optional) + Date and time on or before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :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 is descending. If no value is specified timeStarted is default. + + Allowed values are: "timeStarted", "timeFinished", "problemCount", "highestProblemSeverity", "timeCompleted" + + :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 opc_request_id: (optional) + The client request ID for tracing. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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.vulnerability_scanning.models.HostAgentScanResultSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_agent_scan_results API. + """ + resource_path = "/hostAgentScanResults" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "instance_id", + "highest_problem_severity", + "operating_system", + "time_started_greater_than_or_equal_to", + "time_started_less_than_or_equal_to", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id", + "display_name" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_host_agent_scan_results got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'highest_problem_severity' in kwargs: + highest_problem_severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['highest_problem_severity'] not in highest_problem_severity_allowed_values: + raise ValueError( + "Invalid value for `highest_problem_severity`, must be one of {0}".format(highest_problem_severity_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 = ["timeStarted", "timeFinished", "problemCount", "highestProblemSeverity", "timeCompleted"] + 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, + "instanceId": kwargs.get("instance_id", missing), + "highestProblemSeverity": kwargs.get("highest_problem_severity", missing), + "operatingSystem": kwargs.get("operating_system", missing), + "timeStartedGreaterThanOrEqualTo": kwargs.get("time_started_greater_than_or_equal_to", missing), + "timeStartedLessThanOrEqualTo": kwargs.get("time_started_less_than_or_equal_to", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "displayName": kwargs.get("display_name", 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="HostAgentScanResultSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostAgentScanResultSummaryCollection") + + def list_host_cis_benchmark_scan_results(self, compartment_id, **kwargs): + """ + Returns a collection of HostCisBenchmarkScanResultSummary objects + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str instance_id: (optional) + The ID of a compute instance + + :param str highest_problem_severity: (optional) + Parameter to filter by highestProblemSeverity for scan results + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param datetime time_started_greater_than_or_equal_to: (optional) + Date and time on or after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :param datetime time_started_less_than_or_equal_to: (optional) + Date and time on or before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :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 is descending. If no value is specified timeFinished is default. + + Allowed values are: "timeStarted", "timeFinished", "cisBenchmarkScanIssuesCount" + + :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 opc_request_id: (optional) + The client request ID for tracing. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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.vulnerability_scanning.models.HostCisBenchmarkScanResultSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_cis_benchmark_scan_results API. + """ + resource_path = "/hostCisBenchmarkScanResults" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "instance_id", + "highest_problem_severity", + "time_started_greater_than_or_equal_to", + "time_started_less_than_or_equal_to", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id", + "display_name" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_host_cis_benchmark_scan_results got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'highest_problem_severity' in kwargs: + highest_problem_severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['highest_problem_severity'] not in highest_problem_severity_allowed_values: + raise ValueError( + "Invalid value for `highest_problem_severity`, must be one of {0}".format(highest_problem_severity_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 = ["timeStarted", "timeFinished", "cisBenchmarkScanIssuesCount"] + 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, + "instanceId": kwargs.get("instance_id", missing), + "highestProblemSeverity": kwargs.get("highest_problem_severity", missing), + "timeStartedGreaterThanOrEqualTo": kwargs.get("time_started_greater_than_or_equal_to", missing), + "timeStartedLessThanOrEqualTo": kwargs.get("time_started_less_than_or_equal_to", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "displayName": kwargs.get("display_name", 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="HostCisBenchmarkScanResultSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostCisBenchmarkScanResultSummaryCollection") + + def list_host_endpoint_protection_scan_results(self, compartment_id, **kwargs): + """ + Returns a collection of HostEndpointProtectionScanResultSummary objects + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str instance_id: (optional) + The ID of a compute instance + + :param str highest_problem_severity: (optional) + Parameter to filter by highestProblemSeverity for scan results + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param datetime time_started_greater_than_or_equal_to: (optional) + Date and time on or after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :param datetime time_started_less_than_or_equal_to: (optional) + Date and time on or before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :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 is descending. If no value is specified timeFinished is default. + + Allowed values are: "timeStarted", "timeFinished", "problemSeverity" + + :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 opc_request_id: (optional) + The client request ID for tracing. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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.vulnerability_scanning.models.HostEndpointProtectionScanResultSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_endpoint_protection_scan_results API. + """ + resource_path = "/hostEndpointProtectionScanResults" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "instance_id", + "highest_problem_severity", + "time_started_greater_than_or_equal_to", + "time_started_less_than_or_equal_to", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id", + "display_name" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_host_endpoint_protection_scan_results got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'highest_problem_severity' in kwargs: + highest_problem_severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['highest_problem_severity'] not in highest_problem_severity_allowed_values: + raise ValueError( + "Invalid value for `highest_problem_severity`, must be one of {0}".format(highest_problem_severity_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 = ["timeStarted", "timeFinished", "problemSeverity"] + 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, + "instanceId": kwargs.get("instance_id", missing), + "highestProblemSeverity": kwargs.get("highest_problem_severity", missing), + "timeStartedGreaterThanOrEqualTo": kwargs.get("time_started_greater_than_or_equal_to", missing), + "timeStartedLessThanOrEqualTo": kwargs.get("time_started_less_than_or_equal_to", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "displayName": kwargs.get("display_name", 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="HostEndpointProtectionScanResultSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostEndpointProtectionScanResultSummaryCollection") + + def list_host_port_scan_results(self, compartment_id, **kwargs): + """ + Retrieves a list of HostPortScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A port scan result includes a list of open ports that were detected in a specific compute instance. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str instance_id: (optional) + The ID of a compute instance + + :param str highest_problem_severity: (optional) + Parameter to filter by highestProblemSeverity for scan results + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param datetime time_started_greater_than_or_equal_to: (optional) + Date and time on or after which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :param datetime time_started_less_than_or_equal_to: (optional) + Date and time on or before which scans were started, as described in `RFC 3339`__ + + __ https://tools.ietf.org/rfc/rfc3339 + + :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 is descending. If no value is specified timeFinished is default. + + Allowed values are: "timeStarted", "timeFinished", "openPortCount", "highestProblemSeverity", "timeCompleted" + + :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 opc_request_id: (optional) + The client request ID for tracing. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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.vulnerability_scanning.models.HostPortScanResultSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_port_scan_results API. + """ + resource_path = "/hostPortScanResults" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "instance_id", + "highest_problem_severity", + "time_started_greater_than_or_equal_to", + "time_started_less_than_or_equal_to", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id", + "display_name" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_host_port_scan_results got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'highest_problem_severity' in kwargs: + highest_problem_severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['highest_problem_severity'] not in highest_problem_severity_allowed_values: + raise ValueError( + "Invalid value for `highest_problem_severity`, must be one of {0}".format(highest_problem_severity_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 = ["timeStarted", "timeFinished", "openPortCount", "highestProblemSeverity", "timeCompleted"] + 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, + "instanceId": kwargs.get("instance_id", missing), + "highestProblemSeverity": kwargs.get("highest_problem_severity", missing), + "timeStartedGreaterThanOrEqualTo": kwargs.get("time_started_greater_than_or_equal_to", missing), + "timeStartedLessThanOrEqualTo": kwargs.get("time_started_less_than_or_equal_to", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "displayName": kwargs.get("display_name", 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="HostPortScanResultSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostPortScanResultSummaryCollection") + + def list_host_scan_recipes(self, compartment_id, **kwargs): + """ + Retrieves a list of HostScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned, and how often to scan. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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 :class:`~oci.vulnerability_scanning.models.HostScanRecipeSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_scan_recipes API. + """ + resource_path = "/hostScanRecipes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "lifecycle_state", + "display_name", + "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_host_scan_recipes 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, + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", 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="HostScanRecipeSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostScanRecipeSummaryCollection") + + def list_host_scan_targets(self, compartment_id, **kwargs): + """ + Retrieves a list of HostScanTargetSummary objects in a compartment. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :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 :class:`~oci.vulnerability_scanning.models.HostScanTargetSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_scan_targets API. + """ + resource_path = "/hostScanTargets" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "lifecycle_state", + "display_name", + "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_host_scan_targets 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, + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", 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="HostScanTargetSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostScanTargetSummaryCollection") + + def list_host_vulnerabilities(self, compartment_id, **kwargs): + """ + Retrieves a list of HostVulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :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 severity: (optional) + A filter to return only resources that have a severity that matches the given severity + + Allowed values are: "NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL" + + :param str name: (optional) + A filter to return only resources that match the entire name given. + + :param str cve_reference: (optional) + Parameter to filter by CVE reference number for vulnerabilities + + :param str vulnerability_type: (optional) + The field to filter vulnerabilities based on its type. Only one value can be provided. + + Allowed values are: "CVE", "PROBLEM" + + :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 'name' is Ascending. Default order for other values is descending. If no value is specified name is default. + + Allowed values are: "name", "severity", "impactedHosts", "firstDetected", "lastDetected" + + :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.vulnerability_scanning.models.HostVulnerabilitySummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_vulnerabilities API. + """ + resource_path = "/hostVulnerabilities" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "limit", + "page", + "severity", + "name", + "cve_reference", + "vulnerability_type", + "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_host_vulnerabilities got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'severity' in kwargs: + severity_allowed_values = ["NONE", "LOW", "MEDIUM", "HIGH", "CRITICAL"] + if kwargs['severity'] not in severity_allowed_values: + raise ValueError( + "Invalid value for `severity`, must be one of {0}".format(severity_allowed_values) + ) + + if 'vulnerability_type' in kwargs: + vulnerability_type_allowed_values = ["CVE", "PROBLEM"] + if kwargs['vulnerability_type'] not in vulnerability_type_allowed_values: + raise ValueError( + "Invalid value for `vulnerability_type`, must be one of {0}".format(vulnerability_type_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 = ["name", "severity", "impactedHosts", "firstDetected", "lastDetected"] + 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, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "severity": kwargs.get("severity", missing), + "name": kwargs.get("name", missing), + "cveReference": kwargs.get("cve_reference", missing), + "vulnerabilityType": kwargs.get("vulnerability_type", 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="HostVulnerabilitySummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="HostVulnerabilitySummaryCollection") + + def list_host_vulnerability_impacted_hosts(self, host_vulnerability_id, **kwargs): + """ + Retrieves a list of HostVulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected. + + + :param str host_vulnerability_id: (required) + unique host scan vulnerability identifier + + :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 is Ascending. If no value is specified instanceId is default. + + Allowed values are: "instanceId" + + :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 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.vulnerability_scanning.models.HostVulnerabilityImpactedHostSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_host_vulnerability_impacted_hosts API. + """ + resource_path = "/hostVulnerabilities/{hostVulnerabilityId}/impactedHosts" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "sort_order", + "sort_by", + "limit", + "page", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_host_vulnerability_impacted_hosts got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostVulnerabilityId": host_vulnerability_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)) + + 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 = ["instanceId"] + 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 = { + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing), + "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="HostVulnerabilityImpactedHostSummaryCollection") + 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="HostVulnerabilityImpactedHostSummaryCollection") + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Return a (paginated) list of errors for a given work request. + + + :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 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 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.vulnerability_scanning.models.WorkRequestErrorCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + resource_path = "/workRequests/{workRequestId}/errors" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "page", + "limit" + ] + 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 = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", 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="WorkRequestErrorCollection") + 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="WorkRequestErrorCollection") + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Return a (paginated) list of logs for a given work request. + + + :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 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 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.vulnerability_scanning.models.WorkRequestLogEntryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "page", + "limit" + ] + 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 = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", 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="WorkRequestLogEntryCollection") + 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="WorkRequestLogEntryCollection") + + def list_work_requests(self, compartment_id, **kwargs): + """ + 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 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.vulnerability_scanning.models.WorkRequestCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + resource_path = "/workRequests" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "page", + "limit" + ] + 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) + } + 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="WorkRequestCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestCollection") + + def update_container_scan_recipe(self, container_scan_recipe_id, update_container_scan_recipe_details, **kwargs): + """ + Updates the ContainerScanRecipe identified by the id + + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe identifier + + :param oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails update_container_scan_recipe_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` + + :example: + Click `here `__ to see an example of how to use update_container_scan_recipe API. + """ + resource_path = "/containerScanRecipes/{containerScanRecipeId}" + 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_container_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanRecipeId": container_scan_recipe_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_container_scan_recipe_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_container_scan_recipe_details) + + def update_container_scan_target(self, container_scan_target_id, update_container_scan_target_details, **kwargs): + """ + Updates the ContainerScanTarget identified by the id + + + :param str container_scan_target_id: (required) + unique ContainerScanTarget identifier + + :param oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails update_container_scan_target_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` + + :example: + Click `here `__ to see an example of how to use update_container_scan_target API. + """ + resource_path = "/containerScanTargets/{containerScanTargetId}" + 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_container_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "containerScanTargetId": container_scan_target_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_container_scan_target_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_container_scan_target_details) + + def update_host_scan_recipe(self, host_scan_recipe_id, update_host_scan_recipe_details, **kwargs): + """ + Updates the HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan. + + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe identifier + + :param oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails update_host_scan_recipe_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` + + :example: + Click `here `__ to see an example of how to use update_host_scan_recipe API. + """ + resource_path = "/hostScanRecipes/{hostScanRecipeId}" + 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_host_scan_recipe got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanRecipeId": host_scan_recipe_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_host_scan_recipe_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_host_scan_recipe_details) + + def update_host_scan_target(self, host_scan_target_id, update_host_scan_target_details, **kwargs): + """ + Updates the HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. + + + :param str host_scan_target_id: (required) + unique HostScanTarget identifier + + :param oci.vulnerability_scanning.models.UpdateHostScanTargetDetails update_host_scan_target_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` + + :example: + Click `here `__ to see an example of how to use update_host_scan_target API. + """ + resource_path = "/hostScanTargets/{hostScanTargetId}" + 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_host_scan_target got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "hostScanTargetId": host_scan_target_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_host_scan_target_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_host_scan_target_details) diff --git a/src/oci/vulnerability_scanning/vulnerability_scanning_client_composite_operations.py b/src/oci/vulnerability_scanning/vulnerability_scanning_client_composite_operations.py new file mode 100644 index 0000000000..e564ae9cee --- /dev/null +++ b/src/oci/vulnerability_scanning/vulnerability_scanning_client_composite_operations.py @@ -0,0 +1,754 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class VulnerabilityScanningClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.vulnerability_scanning.VulnerabilityScanningClient` 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 VulnerabilityScanningClientCompositeOperations object + + :param VulnerabilityScanningClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_container_scan_recipe_and_wait_for_state(self, create_container_scan_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_container_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param oci.vulnerability_scanning.models.CreateContainerScanRecipeDetails create_container_scan_recipe_details: (required) + Details for the new ContainerScanRecipe + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_container_scan_recipe` + + :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_container_scan_recipe(create_container_scan_recipe_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_container_scan_target_and_wait_for_state(self, create_container_scan_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_container_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param oci.vulnerability_scanning.models.CreateContainerScanTargetDetails create_container_scan_target_details: (required) + Details for the new ContainerScanTarget + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_container_scan_target` + + :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_container_scan_target(create_container_scan_target_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_host_scan_recipe_and_wait_for_state(self, create_host_scan_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_host_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param oci.vulnerability_scanning.models.CreateHostScanRecipeDetails create_host_scan_recipe_details: (required) + Details for the new HostScanRecipe + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_host_scan_recipe` + + :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_host_scan_recipe(create_host_scan_recipe_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_host_scan_target_and_wait_for_state(self, create_host_scan_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_host_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param oci.vulnerability_scanning.models.CreateHostScanTargetDetails create_host_scan_target_details: (required) + Details for the new HostScanTarget + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.create_host_scan_target` + + :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_host_scan_target(create_host_scan_target_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_container_scan_recipe_and_wait_for_state(self, container_scan_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_recipe` + + :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_container_scan_recipe(container_scan_recipe_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_container_scan_result_and_wait_for_state(self, container_scan_result_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_result` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str container_scan_result_id: (required) + unique container scan identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_result` + + :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_container_scan_result(container_scan_result_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_container_scan_target_and_wait_for_state(self, container_scan_target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str container_scan_target_id: (required) + unique ContainerScanTarget identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_container_scan_target` + + :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_container_scan_target(container_scan_target_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_agent_scan_result_and_wait_for_state(self, host_agent_scan_result_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_agent_scan_result` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_agent_scan_result_id: (required) + unique host agent scan identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_agent_scan_result` + + :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_host_agent_scan_result(host_agent_scan_result_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_cis_benchmark_scan_result_and_wait_for_state(self, host_cis_benchmark_scan_result_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_cis_benchmark_scan_result` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_cis_benchmark_scan_result_id: (required) + unique host Cis benchmark scan identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_cis_benchmark_scan_result` + + :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_host_cis_benchmark_scan_result(host_cis_benchmark_scan_result_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_endpoint_protection_scan_result_and_wait_for_state(self, host_endpoint_protection_scan_result_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_endpoint_protection_scan_result` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_endpoint_protection_scan_result_id: (required) + unique host endpoint protection scan identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_endpoint_protection_scan_result` + + :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_host_endpoint_protection_scan_result(host_endpoint_protection_scan_result_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_port_scan_result_and_wait_for_state(self, host_port_scan_result_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_port_scan_result` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_port_scan_result_id: (required) + unique host port scan identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_port_scan_result` + + :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_host_port_scan_result(host_port_scan_result_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_scan_recipe_and_wait_for_state(self, host_scan_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_scan_recipe` + + :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_host_scan_recipe(host_scan_recipe_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_host_scan_target_and_wait_for_state(self, host_scan_target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_scan_target_id: (required) + unique HostScanTarget identifier + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.delete_host_scan_target` + + :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_host_scan_target(host_scan_target_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_container_scan_recipe_and_wait_for_state(self, container_scan_recipe_id, update_container_scan_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_container_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str container_scan_recipe_id: (required) + unique ContainerScanRecipe identifier + + :param oci.vulnerability_scanning.models.UpdateContainerScanRecipeDetails update_container_scan_recipe_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.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_container_scan_recipe` + + :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_container_scan_recipe(container_scan_recipe_id, update_container_scan_recipe_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_container_scan_target_and_wait_for_state(self, container_scan_target_id, update_container_scan_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_container_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str container_scan_target_id: (required) + unique ContainerScanTarget identifier + + :param oci.vulnerability_scanning.models.UpdateContainerScanTargetDetails update_container_scan_target_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.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_container_scan_target` + + :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_container_scan_target(container_scan_target_id, update_container_scan_target_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_host_scan_recipe_and_wait_for_state(self, host_scan_recipe_id, update_host_scan_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_host_scan_recipe` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_scan_recipe_id: (required) + unique HostScanRecipe identifier + + :param oci.vulnerability_scanning.models.UpdateHostScanRecipeDetails update_host_scan_recipe_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.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_host_scan_recipe` + + :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_host_scan_recipe(host_scan_recipe_id, update_host_scan_recipe_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_host_scan_target_and_wait_for_state(self, host_scan_target_id, update_host_scan_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_host_scan_target` and waits for the :py:class:`~oci.vulnerability_scanning.models.WorkRequest` + to enter the given state(s). + + :param str host_scan_target_id: (required) + unique HostScanTarget identifier + + :param oci.vulnerability_scanning.models.UpdateHostScanTargetDetails update_host_scan_target_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.vulnerability_scanning.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.vulnerability_scanning.VulnerabilityScanningClient.update_host_scan_target` + + :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_host_scan_target(host_scan_target_id, update_host_scan_target_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)