Class CloudGuardClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.cloudguard.CloudGuardClient
-
- All Implemented Interfaces:
CloudGuard
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200131") public class CloudGuardClient extends BaseSyncClient implements CloudGuard
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CloudGuardClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for CloudGuard.
-
Constructor Summary
Constructors Constructor Description CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddCompartmentResponse
addCompartment(AddCompartmentRequest request)
Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId.static CloudGuardClient.Builder
builder()
Create a builder for this client.CancelWorkRequestResponse
cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request identified by workRequestId.ChangeDataSourceCompartmentResponse
changeDataSourceCompartment(ChangeDataSourceCompartmentRequest request)
Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.ChangeDetectorRecipeCompartmentResponse
changeDetectorRecipeCompartment(ChangeDetectorRecipeCompartmentRequest request)
Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment.ChangeManagedListCompartmentResponse
changeManagedListCompartment(ChangeManagedListCompartmentRequest request)
Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.ChangeResponderRecipeCompartmentResponse
changeResponderRecipeCompartment(ChangeResponderRecipeCompartmentRequest request)
Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.ChangeSavedQueryCompartmentResponse
changeSavedQueryCompartment(ChangeSavedQueryCompartmentRequest request)
Moves the SavedQuery resource into a different compartment.ChangeSecurityRecipeCompartmentResponse
changeSecurityRecipeCompartment(ChangeSecurityRecipeCompartmentRequest request)
Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment.ChangeSecurityZoneCompartmentResponse
changeSecurityZoneCompartment(ChangeSecurityZoneCompartmentRequest request)
Moves a security zone, identified by securityZoneId, to a different compartment.void
close()
CreateAdhocQueryResponse
createAdhocQuery(CreateAdhocQueryRequest request)
Creates a AdhocQuery resource.CreateDataMaskRuleResponse
createDataMaskRule(CreateDataMaskRuleRequest request)
Creates a new DataMaskRule resource definition.CreateDataSourceResponse
createDataSource(CreateDataSourceRequest request)
Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.CreateDetectorRecipeResponse
createDetectorRecipe(CreateDetectorRecipeRequest request)
Creates a new DetectorRecipe resource.CreateDetectorRecipeDetectorRuleResponse
createDetectorRecipeDetectorRule(CreateDetectorRecipeDetectorRuleRequest request)
Creates a detector rule.CreateManagedListResponse
createManagedList(CreateManagedListRequest request)
Creates a new ManagedList resource.CreateResponderRecipeResponse
createResponderRecipe(CreateResponderRecipeRequest request)
Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.CreateSavedQueryResponse
createSavedQuery(CreateSavedQueryRequest request)
Creates a SavedQuery resource.CreateSecurityRecipeResponse
createSecurityRecipe(CreateSecurityRecipeRequest request)
Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.CreateSecurityZoneResponse
createSecurityZone(CreateSecurityZoneRequest request)
Creates a security zone (SecurityZone resource) for a compartment.CreateTargetResponse
createTarget(CreateTargetRequest request)
Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.CreateTargetDetectorRecipeResponse
createTargetDetectorRecipe(CreateTargetDetectorRecipeRequest request)
Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.CreateTargetResponderRecipeResponse
createTargetResponderRecipe(CreateTargetResponderRecipeRequest request)
Attaches a responder recipe to a target.CreateWlpAgentResponse
createWlpAgent(CreateWlpAgentRequest request)
Creates and registers a WLP agent for an on-premise resource.DeleteAdhocQueryResponse
deleteAdhocQuery(DeleteAdhocQueryRequest request)
Deletes a AdhocQuery resource identified by adhocQueryId.DeleteDataMaskRuleResponse
deleteDataMaskRule(DeleteDataMaskRuleRequest request)
Deletes a DataMaskRule resource, identified by dataMaskRuleId.DeleteDataSourceResponse
deleteDataSource(DeleteDataSourceRequest request)
Deletes a data source (DataSource resource) identified by dataSourceId.DeleteDetectorRecipeResponse
deleteDetectorRecipe(DeleteDetectorRecipeRequest request)
Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.DeleteDetectorRecipeDetectorRuleResponse
deleteDetectorRecipeDetectorRule(DeleteDetectorRecipeDetectorRuleRequest request)
Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.DeleteDetectorRecipeDetectorRuleDataSourceResponse
deleteDetectorRecipeDetectorRuleDataSource(DeleteDetectorRecipeDetectorRuleDataSourceRequest request)
Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.DeleteManagedListResponse
deleteManagedList(DeleteManagedListRequest request)
Deletes a managed list identified by managedListId.DeleteResponderRecipeResponse
deleteResponderRecipe(DeleteResponderRecipeRequest request)
Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.DeleteSavedQueryResponse
deleteSavedQuery(DeleteSavedQueryRequest request)
Deletes a SavedQuery resource identified by savedQueryId.DeleteSecurityRecipeResponse
deleteSecurityRecipe(DeleteSecurityRecipeRequest request)
Deletes a security zone recipe, identified by securityRecipeId.DeleteSecurityZoneResponse
deleteSecurityZone(DeleteSecurityZoneRequest request)
Deletes a security zone, identified by securityZoneId.DeleteTargetResponse
deleteTarget(DeleteTargetRequest request)
Deletes a target (Target resource) identified by targetId.DeleteTargetDetectorRecipeResponse
deleteTargetDetectorRecipe(DeleteTargetDetectorRecipeRequest request)
Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.DeleteTargetResponderRecipeResponse
deleteTargetResponderRecipe(DeleteTargetResponderRecipeRequest request)
Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.DeleteWlpAgentResponse
deleteWlpAgent(DeleteWlpAgentRequest request)
Deletes and unregisters the WLP agent for an on-premise resource.ExecuteResponderExecutionResponse
executeResponderExecution(ExecuteResponderExecutionRequest request)
Executes the responder execution.GetAdhocQueryResponse
getAdhocQuery(GetAdhocQueryRequest request)
Returns an adhoc query identified by adhocQueryId.GetAdhocQueryResultContentResponse
getAdhocQueryResultContent(GetAdhocQueryResultContentRequest request)
Downloads the results for a given adhoc ID (from includes results from all monitoring regions).String
getClientCommonLibraryVersion()
GetConditionMetadataTypeResponse
getConditionMetadataType(GetConditionMetadataTypeRequest request)
Returns a ConditionMetatDataType resource with its details.GetConfigurationResponse
getConfiguration(GetConfigurationRequest request)
Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.GetDataMaskRuleResponse
getDataMaskRule(GetDataMaskRuleRequest request)
Returns a DataMaskRule resource, identified by dataMaskRuleId.GetDataSourceResponse
getDataSource(GetDataSourceRequest request)
Returns a data source (DataSource resource) identified by dataSourceId.protected ClientConfigurator
getDefaultConfigurator()
GetDetectorResponse
getDetector(GetDetectorRequest request)
Returns a Detector resource, identified by detectorId.GetDetectorRecipeResponse
getDetectorRecipe(GetDetectorRecipeRequest request)
Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.GetDetectorRecipeDetectorRuleResponse
getDetectorRecipeDetectorRule(GetDetectorRecipeDetectorRuleRequest request)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.GetDetectorRuleResponse
getDetectorRule(GetDetectorRuleRequest request)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.String
getEndpoint()
GetManagedListResponse
getManagedList(GetManagedListRequest request)
Returns a managed list identified by managedListId.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
CloudGuardPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetProblemResponse
getProblem(GetProblemRequest request)
Returns the Problem resource identified by problemId.GetResourceResponse
getResource(GetResourceRequest request)
Returns a resource identified by resourceIdGetResourceProfileResponse
getResourceProfile(GetResourceProfileRequest request)
Returns details for a resource profile, identified by resourceProfileId.GetResourceVulnerabilityResponse
getResourceVulnerability(GetResourceVulnerabilityRequest request)
Returns the vulnerability details associated with the cveId where resource is an instanceGetResponderExecutionResponse
getResponderExecution(GetResponderExecutionRequest request)
Returns a responder execution identified by responderExecutionId.GetResponderRecipeResponse
getResponderRecipe(GetResponderRecipeRequest request)
Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.GetResponderRecipeResponderRuleResponse
getResponderRecipeResponderRule(GetResponderRecipeResponderRuleRequest request)
Returns a responder rule (ResponderRule resource) identified by responderRuleId.GetResponderRuleResponse
getResponderRule(GetResponderRuleRequest request)
Returns a responder rule (ResponderRule resource) identified by resonderRuleId.GetSavedQueryResponse
getSavedQuery(GetSavedQueryRequest request)
Returns a SavedQuery resource identified by savedQueryId.GetSecurityPolicyResponse
getSecurityPolicy(GetSecurityPolicyRequest request)
Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId).GetSecurityRecipeResponse
getSecurityRecipe(GetSecurityRecipeRequest request)
Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.GetSecurityZoneResponse
getSecurityZone(GetSecurityZoneRequest request)
Returns a security zone (SecurityZone resource) identified by securityZoneId.GetSightingResponse
getSighting(GetSightingRequest request)
Returns a single sighting (Sighting resource) identified by sightingId.GetTargetResponse
getTarget(GetTargetRequest request)
Returns a target (Target resource) identified by targetId.GetTargetDetectorRecipeResponse
getTargetDetectorRecipe(GetTargetDetectorRecipeRequest request)
Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.GetTargetDetectorRecipeDetectorRuleResponse
getTargetDetectorRecipeDetectorRule(GetTargetDetectorRecipeDetectorRuleRequest request)
Returns DetectorRule resource by identified by targetDetectorRecipeId.GetTargetResponderRecipeResponse
getTargetResponderRecipe(GetTargetResponderRecipeRequest request)
Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.GetTargetResponderRecipeResponderRuleResponse
getTargetResponderRecipeResponderRule(GetTargetResponderRecipeResponderRuleRequest request)
Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.CloudGuardWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWlpAgentResponse
getWlpAgent(GetWlpAgentRequest request)
Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Returns details for a work request (WorkRequest resource) identified by workRequestId.ListAdhocQueriesResponse
listAdhocQueries(ListAdhocQueriesRequest request)
Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId.ListAdhocQueryResultsResponse
listAdhocQueryResults(ListAdhocQueryResultsRequest request)
Lists the results for a given adhoc ID (from includes results from all monitoring regions).ListConditionMetadataTypesResponse
listConditionMetadataTypes(ListConditionMetadataTypesRequest request)
Returns a list of ConditionMetadataType resources.ListDataMaskRulesResponse
listDataMaskRules(ListDataMaskRulesRequest request)
Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.ListDataSourceEventsResponse
listDataSourceEvents(ListDataSourceEventsRequest request)
Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.ListDataSourcesResponse
listDataSources(ListDataSourcesRequest request)
Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId.ListDetectorRecipeDetectorRulesResponse
listDetectorRecipeDetectorRules(ListDetectorRecipeDetectorRulesRequest request)
Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.ListDetectorRecipesResponse
listDetectorRecipes(ListDetectorRecipesRequest request)
Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.ListDetectorRulesResponse
listDetectorRules(ListDetectorRulesRequest request)
Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.ListDetectorsResponse
listDetectors(ListDetectorsRequest request)
Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.ListImpactedResourcesResponse
listImpactedResources(ListImpactedResourcesRequest request)
Returns a list of impacted resources for a problem identified by problemId.ListManagedListsResponse
listManagedLists(ListManagedListsRequest request)
Returns a list of all ManagedList resources in a compartment, identified by compartmentId.ListManagedListTypesResponse
listManagedListTypes(ListManagedListTypesRequest request)
Returns all managed list types (listType parameter) that Cloud Guard supports.ListPoliciesResponse
listPolicies(ListPoliciesRequest request)
Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.ListProblemEndpointsResponse
listProblemEndpoints(ListProblemEndpointsRequest request)
Returns a list of endpoints associated with a problem, identified by problemId.ListProblemEntitiesResponse
listProblemEntities(ListProblemEntitiesRequest request)
Returns a list of entities for a problem.ListProblemHistoriesResponse
listProblemHistories(ListProblemHistoriesRequest request)
Returns a list of actions taken on a problem.ListProblemsResponse
listProblems(ListProblemsRequest request)
Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.ListRecommendationsResponse
listRecommendations(ListRecommendationsRequest request)
Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.ListResourcePortsResponse
listResourcePorts(ListResourcePortsRequest request)
Returns the list of open ports associated with the resourceId where resource is an instanceListResourceProfileEndpointsResponse
listResourceProfileEndpoints(ListResourceProfileEndpointsRequest request)
Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.ListResourceProfileImpactedResourcesResponse
listResourceProfileImpactedResources(ListResourceProfileImpactedResourcesRequest request)
Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.ListResourceProfilesResponse
listResourceProfiles(ListResourceProfilesRequest request)
Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.ListResourcesResponse
listResources(ListResourcesRequest request)
Returns a list of all resources in a compartmentListResourceTypesResponse
listResourceTypes(ListResourceTypesRequest request)
Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.ListResourceVulnerabilitiesResponse
listResourceVulnerabilities(ListResourceVulnerabilitiesRequest request)
Returns the list of vulnerabilities associated with the resourceId where resource is an instanceListResponderActivitiesResponse
listResponderActivities(ListResponderActivitiesRequest request)
Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.ListResponderExecutionsResponse
listResponderExecutions(ListResponderExecutionsRequest request)
Returns a list of responder executions.ListResponderRecipeResponderRulesResponse
listResponderRecipeResponderRules(ListResponderRecipeResponderRulesRequest request)
Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.ListResponderRecipesResponse
listResponderRecipes(ListResponderRecipesRequest request)
Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.ListResponderRulesResponse
listResponderRules(ListResponderRulesRequest request)
Returns a list of responder rules for the ResponderRecipe resource identified by responderId.ListSavedQueriesResponse
listSavedQueries(ListSavedQueriesRequest request)
Returns a list of saved queries run in a tenancy.ListSecurityPoliciesResponse
listSecurityPolicies(ListSecurityPoliciesRequest request)
Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.ListSecurityRecipesResponse
listSecurityRecipes(ListSecurityRecipesRequest request)
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.ListSecurityZonesResponse
listSecurityZones(ListSecurityZonesRequest request)
Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId.ListSightingEndpointsResponse
listSightingEndpoints(ListSightingEndpointsRequest request)
Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.ListSightingImpactedResourcesResponse
listSightingImpactedResources(ListSightingImpactedResourcesRequest request)
Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.ListSightingsResponse
listSightings(ListSightingsRequest request)
For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.ListTacticsResponse
listTactics(ListTacticsRequest request)
Returns a list of TacticSummary resources for a compartment, identified by compartmentId.ListTargetDetectorRecipeDetectorRulesResponse
listTargetDetectorRecipeDetectorRules(ListTargetDetectorRecipeDetectorRulesRequest request)
Returns a list of DetectorRule associated with DetectorRecipe within a Target.ListTargetDetectorRecipesResponse
listTargetDetectorRecipes(ListTargetDetectorRecipesRequest request)
Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId.ListTargetResponderRecipeResponderRulesResponse
listTargetResponderRecipeResponderRules(ListTargetResponderRecipeResponderRulesRequest request)
Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target.ListTargetResponderRecipesResponse
listTargetResponderRecipes(ListTargetResponderRecipesRequest request)
Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.ListTargetsResponse
listTargets(ListTargetsRequest request)
Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId.ListTechniquesResponse
listTechniques(ListTechniquesRequest request)
Returns a list of techniques associated with detector rules.ListWlpAgentsResponse
listWlpAgents(ListWlpAgentsRequest request)
Returns a list of WLP agents in a compartment.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a list of errors for a work request identified by workRequestId.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.RemoveCompartmentResponse
removeCompartment(RemoveCompartmentRequest request)
Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.RequestRiskScoresResponse
requestRiskScores(RequestRiskScoresRequest request)
Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.RequestSecurityScoresResponse
requestSecurityScores(RequestSecurityScoresRequest request)
Returns a page of SecurityScoreAggregation resources.RequestSecurityScoreSummarizedTrendResponse
requestSecurityScoreSummarizedTrend(RequestSecurityScoreSummarizedTrendRequest request)
Returns a page of SecurityScoreTrendAggregation resources.RequestSummarizedActivityProblemsResponse
requestSummarizedActivityProblems(RequestSummarizedActivityProblemsRequest request)
Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.RequestSummarizedProblemsResponse
requestSummarizedProblems(RequestSummarizedProblemsRequest request)
Returns the number of problems matching the key-value pairs in dimensionMap.RequestSummarizedResponderExecutionsResponse
requestSummarizedResponderExecutions(RequestSummarizedResponderExecutionsRequest request)
Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.RequestSummarizedRiskScoresResponse
requestSummarizedRiskScores(RequestSummarizedRiskScoresRequest request)
DEPRECATEDRequestSummarizedSecurityScoresResponse
requestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest request)
DEPRECATEDRequestSummarizedTopTrendResourceProfileRiskScoresResponse
requestSummarizedTopTrendResourceProfileRiskScores(RequestSummarizedTopTrendResourceProfileRiskScoresRequest request)
Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.RequestSummarizedTrendProblemsResponse
requestSummarizedTrendProblems(RequestSummarizedTrendProblemsRequest request)
Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period.RequestSummarizedTrendResourceRiskScoresResponse
requestSummarizedTrendResourceRiskScores(RequestSummarizedTrendResourceRiskScoresRequest request)
Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.RequestSummarizedTrendResponderExecutionsResponse
requestSummarizedTrendResponderExecutions(RequestSummarizedTrendResponderExecutionsRequest request)
Returns the number of remediations performed by Responders, for a given time period.RequestSummarizedTrendSecurityScoresResponse
requestSummarizedTrendSecurityScores(RequestSummarizedTrendSecurityScoresRequest request)
DEPRECATEDvoid
setEndpoint(String endpoint)
void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).SkipBulkResponderExecutionResponse
skipBulkResponderExecution(SkipBulkResponderExecutionRequest request)
Skips the execution for a bulk of responder executions.SkipResponderExecutionResponse
skipResponderExecution(SkipResponderExecutionRequest request)
Skips the execution of the responder execution.TriggerResponderResponse
triggerResponder(TriggerResponderRequest request)
Sends the problem identified by problemId to the responder engine, to be processed by rule that\u2019s identified by responderRuleId, in the TriggerResponderDetails resource that\u2019s passed.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateBulkProblemStatusResponse
updateBulkProblemStatus(UpdateBulkProblemStatusRequest request)
Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.UpdateConfigurationResponse
updateConfiguration(UpdateConfigurationRequest request)
Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID.UpdateDataMaskRuleResponse
updateDataMaskRule(UpdateDataMaskRuleRequest request)
Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.UpdateDataSourceResponse
updateDataSource(UpdateDataSourceRequest request)
Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.UpdateDetectorRecipeResponse
updateDetectorRecipe(UpdateDetectorRecipeRequest request)
Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.UpdateDetectorRecipeDetectorRuleResponse
updateDetectorRecipeDetectorRule(UpdateDetectorRecipeDetectorRuleRequest request)
Updates a detector rule (DetectorRule resource) identified by detectorRuleId.UpdateManagedListResponse
updateManagedList(UpdateManagedListRequest request)
Updates a ManagedList resource, identified by managedList.UpdateProblemStatusResponse
updateProblemStatus(UpdateProblemStatusRequest request)
Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.UpdateResponderRecipeResponse
updateResponderRecipe(UpdateResponderRecipeRequest request)
Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.UpdateResponderRecipeResponderRuleResponse
updateResponderRecipeResponderRule(UpdateResponderRecipeResponderRuleRequest request)
Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.UpdateSavedQueryResponse
updateSavedQuery(UpdateSavedQueryRequest request)
Updates a saved query identified by savedQueryId.UpdateSecurityRecipeResponse
updateSecurityRecipe(UpdateSecurityRecipeRequest request)
Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.UpdateSecurityZoneResponse
updateSecurityZone(UpdateSecurityZoneRequest request)
Updates a security zone (SecurityZone resource) identified by securityZoneId.UpdateTargetResponse
updateTarget(UpdateTargetRequest request)
Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.UpdateTargetDetectorRecipeResponse
updateTargetDetectorRecipe(UpdateTargetDetectorRecipeRequest request)
Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.UpdateTargetDetectorRecipeDetectorRuleResponse
updateTargetDetectorRecipeDetectorRule(UpdateTargetDetectorRecipeDetectorRuleRequest request)
Updates the DetectorRule resource identified by targetDetectorRecipeIdUpdateTargetResponderRecipeResponse
updateTargetResponderRecipe(UpdateTargetResponderRecipeRequest request)
Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId.UpdateTargetResponderRecipeResponderRuleResponse
updateTargetResponderRecipeResponderRule(UpdateTargetResponderRecipeResponderRuleRequest request)
Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId.UpdateWlpAgentResponse
updateWlpAgent(UpdateWlpAgentRequest request)
Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.cloudguard.CloudGuard
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
CloudGuardClient
@Deprecated public CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
CloudGuardClient
@Deprecated public CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
CloudGuardClient
@Deprecated public CloudGuardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
CloudGuardClient
@Deprecated public CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
CloudGuardClient
@Deprecated public CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
CloudGuardClient
@Deprecated public CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
CloudGuardClient
@Deprecated public CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
CloudGuardClient
@Deprecated public CloudGuardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeCloudGuardClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-CloudGuardClient.Builder.executorService
-
-
Method Detail
-
builder
public static CloudGuardClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:CloudGuard
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegion
in interfaceCloudGuard
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:CloudGuard
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Specified by:
setRegion
in interfaceCloudGuard
- Parameters:
regionId
- The public region ID.
-
addCompartment
public AddCompartmentResponse addCompartment(AddCompartmentRequest request)
Description copied from interface:CloudGuard
Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId.Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone’s policies.
- Specified by:
addCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelWorkRequest
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Description copied from interface:CloudGuard
Cancels a work request identified by workRequestId.- Specified by:
cancelWorkRequest
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDataSourceCompartment
public ChangeDataSourceCompartmentResponse changeDataSourceCompartment(ChangeDataSourceCompartmentRequest request)
Description copied from interface:CloudGuard
Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.- Specified by:
changeDataSourceCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDetectorRecipeCompartment
public ChangeDetectorRecipeCompartmentResponse changeDetectorRecipeCompartment(ChangeDetectorRecipeCompartmentRequest request)
Description copied from interface:CloudGuard
Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment.When provided, If-Match is checked against etag values of the resource.
- Specified by:
changeDetectorRecipeCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeManagedListCompartment
public ChangeManagedListCompartmentResponse changeManagedListCompartment(ChangeManagedListCompartmentRequest request)
Description copied from interface:CloudGuard
Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.- Specified by:
changeManagedListCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeResponderRecipeCompartment
public ChangeResponderRecipeCompartmentResponse changeResponderRecipeCompartment(ChangeResponderRecipeCompartmentRequest request)
Description copied from interface:CloudGuard
Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.When provided, if-match is checked against etag values of the resource.
- Specified by:
changeResponderRecipeCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSavedQueryCompartment
public ChangeSavedQueryCompartmentResponse changeSavedQueryCompartment(ChangeSavedQueryCompartmentRequest request)
Description copied from interface:CloudGuard
Moves the SavedQuery resource into a different compartment.When provided, If-Match is checked against etag values of the resource.
- Specified by:
changeSavedQueryCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityRecipeCompartment
public ChangeSecurityRecipeCompartmentResponse changeSecurityRecipeCompartment(ChangeSecurityRecipeCompartmentRequest request)
Description copied from interface:CloudGuard
Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment.When provided,
if-match
is checked againstetag
values of the resource.- Specified by:
changeSecurityRecipeCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityZoneCompartment
public ChangeSecurityZoneCompartmentResponse changeSecurityZoneCompartment(ChangeSecurityZoneCompartmentRequest request)
Description copied from interface:CloudGuard
Moves a security zone, identified by securityZoneId, to a different compartment.Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided,
if-match
is checked againstetag
values of the resource.- Specified by:
changeSecurityZoneCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAdhocQuery
public CreateAdhocQueryResponse createAdhocQuery(CreateAdhocQueryRequest request)
Description copied from interface:CloudGuard
Creates a AdhocQuery resource.- Specified by:
createAdhocQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataMaskRule
public CreateDataMaskRuleResponse createDataMaskRule(CreateDataMaskRuleRequest request)
Description copied from interface:CloudGuard
Creates a new DataMaskRule resource definition.- Specified by:
createDataMaskRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataSource
public CreateDataSourceResponse createDataSource(CreateDataSourceRequest request)
Description copied from interface:CloudGuard
Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.- Specified by:
createDataSource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDetectorRecipe
public CreateDetectorRecipeResponse createDetectorRecipe(CreateDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Creates a new DetectorRecipe resource.- Specified by:
createDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDetectorRecipeDetectorRule
public CreateDetectorRecipeDetectorRuleResponse createDetectorRecipeDetectorRule(CreateDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Creates a detector rule.- Specified by:
createDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createManagedList
public CreateManagedListResponse createManagedList(CreateManagedListRequest request)
Description copied from interface:CloudGuard
Creates a new ManagedList resource.- Specified by:
createManagedList
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createResponderRecipe
public CreateResponderRecipeResponse createResponderRecipe(CreateResponderRecipeRequest request)
Description copied from interface:CloudGuard
Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.- Specified by:
createResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSavedQuery
public CreateSavedQueryResponse createSavedQuery(CreateSavedQueryRequest request)
Description copied from interface:CloudGuard
Creates a SavedQuery resource.- Specified by:
createSavedQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecurityRecipe
public CreateSecurityRecipeResponse createSecurityRecipe(CreateSecurityRecipeRequest request)
Description copied from interface:CloudGuard
Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.- Specified by:
createSecurityRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecurityZone
public CreateSecurityZoneResponse createSecurityZone(CreateSecurityZoneRequest request)
Description copied from interface:CloudGuard
Creates a security zone (SecurityZone resource) for a compartment.Pass parameters through a CreateSecurityZoneDetails resource.
- Specified by:
createSecurityZone
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTarget
public CreateTargetResponse createTarget(CreateTargetRequest request)
Description copied from interface:CloudGuard
Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.- Specified by:
createTarget
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTargetDetectorRecipe
public CreateTargetDetectorRecipeResponse createTargetDetectorRecipe(CreateTargetDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.Attach a DetectorRecipe with the Target
- Specified by:
createTargetDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTargetResponderRecipe
public CreateTargetResponderRecipeResponse createTargetResponderRecipe(CreateTargetResponderRecipeRequest request)
Description copied from interface:CloudGuard
Attaches a responder recipe to a target.- Specified by:
createTargetResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWlpAgent
public CreateWlpAgentResponse createWlpAgent(CreateWlpAgentRequest request)
Description copied from interface:CloudGuard
Creates and registers a WLP agent for an on-premise resource.- Specified by:
createWlpAgent
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAdhocQuery
public DeleteAdhocQueryResponse deleteAdhocQuery(DeleteAdhocQueryRequest request)
Description copied from interface:CloudGuard
Deletes a AdhocQuery resource identified by adhocQueryId.- Specified by:
deleteAdhocQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataMaskRule
public DeleteDataMaskRuleResponse deleteDataMaskRule(DeleteDataMaskRuleRequest request)
Description copied from interface:CloudGuard
Deletes a DataMaskRule resource, identified by dataMaskRuleId.- Specified by:
deleteDataMaskRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataSource
public DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
Description copied from interface:CloudGuard
Deletes a data source (DataSource resource) identified by dataSourceId.- Specified by:
deleteDataSource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDetectorRecipe
public DeleteDetectorRecipeResponse deleteDetectorRecipe(DeleteDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.- Specified by:
deleteDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDetectorRecipeDetectorRule
public DeleteDetectorRecipeDetectorRuleResponse deleteDetectorRecipeDetectorRule(DeleteDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.- Specified by:
deleteDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDetectorRecipeDetectorRuleDataSource
public DeleteDetectorRecipeDetectorRuleDataSourceResponse deleteDetectorRecipeDetectorRuleDataSource(DeleteDetectorRecipeDetectorRuleDataSourceRequest request)
Description copied from interface:CloudGuard
Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.- Specified by:
deleteDetectorRecipeDetectorRuleDataSource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteManagedList
public DeleteManagedListResponse deleteManagedList(DeleteManagedListRequest request)
Description copied from interface:CloudGuard
Deletes a managed list identified by managedListId.- Specified by:
deleteManagedList
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteResponderRecipe
public DeleteResponderRecipeResponse deleteResponderRecipe(DeleteResponderRecipeRequest request)
Description copied from interface:CloudGuard
Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.- Specified by:
deleteResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSavedQuery
public DeleteSavedQueryResponse deleteSavedQuery(DeleteSavedQueryRequest request)
Description copied from interface:CloudGuard
Deletes a SavedQuery resource identified by savedQueryId.- Specified by:
deleteSavedQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSecurityRecipe
public DeleteSecurityRecipeResponse deleteSecurityRecipe(DeleteSecurityRecipeRequest request)
Description copied from interface:CloudGuard
Deletes a security zone recipe, identified by securityRecipeId.The recipe can’t be associated with an existing security zone.
- Specified by:
deleteSecurityRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSecurityZone
public DeleteSecurityZoneResponse deleteSecurityZone(DeleteSecurityZoneRequest request)
Description copied from interface:CloudGuard
Deletes a security zone, identified by securityZoneId.- Specified by:
deleteSecurityZone
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTarget
public DeleteTargetResponse deleteTarget(DeleteTargetRequest request)
Description copied from interface:CloudGuard
Deletes a target (Target resource) identified by targetId.- Specified by:
deleteTarget
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTargetDetectorRecipe
public DeleteTargetDetectorRecipeResponse deleteTargetDetectorRecipe(DeleteTargetDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.- Specified by:
deleteTargetDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTargetResponderRecipe
public DeleteTargetResponderRecipeResponse deleteTargetResponderRecipe(DeleteTargetResponderRecipeRequest request)
Description copied from interface:CloudGuard
Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.- Specified by:
deleteTargetResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWlpAgent
public DeleteWlpAgentResponse deleteWlpAgent(DeleteWlpAgentRequest request)
Description copied from interface:CloudGuard
Deletes and unregisters the WLP agent for an on-premise resource.x-obmcs-splat: routing: strategy: route-to-any-ad serviceList: [ ‘cloudguard-cp-SPLAT_ENV’ ] resources: wlpAgent: serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404(‘cloudguard-cp-SPLAT_ENV’, ‘GetWlpAgent’, request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ "WLP_AGENT_DELETE" ] authorization: mode: automated check: resources[‘wlpAgent’].grantedPermissions.contains(‘WLP_AGENT_DELETE’) allowCrossTenancy: true tagStore: mode: automated maximumAttemptCount: 3 throttling: perUserLimit: rpsLimit: 15 perTenantLimit: rpsLimit: 30 quotas: mode: automated search: mode: backfilling operationResourceName: wlpAgent lock: mode: test operationResourceName: wlpAgent
- Specified by:
deleteWlpAgent
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
executeResponderExecution
public ExecuteResponderExecutionResponse executeResponderExecution(ExecuteResponderExecutionRequest request)
Description copied from interface:CloudGuard
Executes the responder execution.When provided, if-match is checked against etag values of the resource.
- Specified by:
executeResponderExecution
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdhocQuery
public GetAdhocQueryResponse getAdhocQuery(GetAdhocQueryRequest request)
Description copied from interface:CloudGuard
Returns an adhoc query identified by adhocQueryId.- Specified by:
getAdhocQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdhocQueryResultContent
public GetAdhocQueryResultContentResponse getAdhocQueryResultContent(GetAdhocQueryResultContentRequest request)
Description copied from interface:CloudGuard
Downloads the results for a given adhoc ID (from includes results from all monitoring regions).- Specified by:
getAdhocQueryResultContent
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConditionMetadataType
public GetConditionMetadataTypeResponse getConditionMetadataType(GetConditionMetadataTypeRequest request)
Description copied from interface:CloudGuard
Returns a ConditionMetatDataType resource with its details.- Specified by:
getConditionMetadataType
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConfiguration
public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
Description copied from interface:CloudGuard
Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.- Specified by:
getConfiguration
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataMaskRule
public GetDataMaskRuleResponse getDataMaskRule(GetDataMaskRuleRequest request)
Description copied from interface:CloudGuard
Returns a DataMaskRule resource, identified by dataMaskRuleId.- Specified by:
getDataMaskRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataSource
public GetDataSourceResponse getDataSource(GetDataSourceRequest request)
Description copied from interface:CloudGuard
Returns a data source (DataSource resource) identified by dataSourceId.- Specified by:
getDataSource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDetector
public GetDetectorResponse getDetector(GetDetectorRequest request)
Description copied from interface:CloudGuard
Returns a Detector resource, identified by detectorId.- Specified by:
getDetector
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDetectorRecipe
public GetDetectorRecipeResponse getDetectorRecipe(GetDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.- Specified by:
getDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDetectorRecipeDetectorRule
public GetDetectorRecipeDetectorRuleResponse getDetectorRecipeDetectorRule(GetDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.- Specified by:
getDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDetectorRule
public GetDetectorRuleResponse getDetectorRule(GetDetectorRuleRequest request)
Description copied from interface:CloudGuard
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.- Specified by:
getDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getManagedList
public GetManagedListResponse getManagedList(GetManagedListRequest request)
Description copied from interface:CloudGuard
Returns a managed list identified by managedListId.- Specified by:
getManagedList
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProblem
public GetProblemResponse getProblem(GetProblemRequest request)
Description copied from interface:CloudGuard
Returns the Problem resource identified by problemId.- Specified by:
getProblem
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResource
public GetResourceResponse getResource(GetResourceRequest request)
Description copied from interface:CloudGuard
Returns a resource identified by resourceId- Specified by:
getResource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResourceProfile
public GetResourceProfileResponse getResourceProfile(GetResourceProfileRequest request)
Description copied from interface:CloudGuard
Returns details for a resource profile, identified by resourceProfileId.- Specified by:
getResourceProfile
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResourceVulnerability
public GetResourceVulnerabilityResponse getResourceVulnerability(GetResourceVulnerabilityRequest request)
Description copied from interface:CloudGuard
Returns the vulnerability details associated with the cveId where resource is an instance- Specified by:
getResourceVulnerability
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResponderExecution
public GetResponderExecutionResponse getResponderExecution(GetResponderExecutionRequest request)
Description copied from interface:CloudGuard
Returns a responder execution identified by responderExecutionId.- Specified by:
getResponderExecution
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResponderRecipe
public GetResponderRecipeResponse getResponderRecipe(GetResponderRecipeRequest request)
Description copied from interface:CloudGuard
Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.- Specified by:
getResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResponderRecipeResponderRule
public GetResponderRecipeResponderRuleResponse getResponderRecipeResponderRule(GetResponderRecipeResponderRuleRequest request)
Description copied from interface:CloudGuard
Returns a responder rule (ResponderRule resource) identified by responderRuleId.- Specified by:
getResponderRecipeResponderRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResponderRule
public GetResponderRuleResponse getResponderRule(GetResponderRuleRequest request)
Description copied from interface:CloudGuard
Returns a responder rule (ResponderRule resource) identified by resonderRuleId.- Specified by:
getResponderRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSavedQuery
public GetSavedQueryResponse getSavedQuery(GetSavedQueryRequest request)
Description copied from interface:CloudGuard
Returns a SavedQuery resource identified by savedQueryId.- Specified by:
getSavedQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityPolicy
public GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest request)
Description copied from interface:CloudGuard
Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId).When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.
- Specified by:
getSecurityPolicy
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityRecipe
public GetSecurityRecipeResponse getSecurityRecipe(GetSecurityRecipeRequest request)
Description copied from interface:CloudGuard
Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.- Specified by:
getSecurityRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityZone
public GetSecurityZoneResponse getSecurityZone(GetSecurityZoneRequest request)
Description copied from interface:CloudGuard
Returns a security zone (SecurityZone resource) identified by securityZoneId.- Specified by:
getSecurityZone
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSighting
public GetSightingResponse getSighting(GetSightingRequest request)
Description copied from interface:CloudGuard
Returns a single sighting (Sighting resource) identified by sightingId.- Specified by:
getSighting
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTarget
public GetTargetResponse getTarget(GetTargetRequest request)
Description copied from interface:CloudGuard
Returns a target (Target resource) identified by targetId.- Specified by:
getTarget
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetDetectorRecipe
public GetTargetDetectorRecipeResponse getTargetDetectorRecipe(GetTargetDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.- Specified by:
getTargetDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetDetectorRecipeDetectorRule
public GetTargetDetectorRecipeDetectorRuleResponse getTargetDetectorRecipeDetectorRule(GetTargetDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Returns DetectorRule resource by identified by targetDetectorRecipeId.- Specified by:
getTargetDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetResponderRecipe
public GetTargetResponderRecipeResponse getTargetResponderRecipe(GetTargetResponderRecipeRequest request)
Description copied from interface:CloudGuard
Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.- Specified by:
getTargetResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTargetResponderRecipeResponderRule
public GetTargetResponderRecipeResponderRuleResponse getTargetResponderRecipeResponderRule(GetTargetResponderRecipeResponderRuleRequest request)
Description copied from interface:CloudGuard
Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.- Specified by:
getTargetResponderRecipeResponderRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWlpAgent
public GetWlpAgentResponse getWlpAgent(GetWlpAgentRequest request)
Description copied from interface:CloudGuard
Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.- Specified by:
getWlpAgent
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:CloudGuard
Returns details for a work request (WorkRequest resource) identified by workRequestId.- Specified by:
getWorkRequest
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdhocQueries
public ListAdhocQueriesResponse listAdhocQueries(ListAdhocQueriesRequest request)
Description copied from interface:CloudGuard
Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId.List is returned in a AdhocQueryCollection resource with page of AdhocQuerySummary resources.
The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listAdhocQueries
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdhocQueryResults
public ListAdhocQueryResultsResponse listAdhocQueryResults(ListAdhocQueryResultsRequest request)
Description copied from interface:CloudGuard
Lists the results for a given adhoc ID (from includes results from all monitoring regions).- Specified by:
listAdhocQueryResults
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConditionMetadataTypes
public ListConditionMetadataTypesResponse listConditionMetadataTypes(ListConditionMetadataTypesRequest request)
Description copied from interface:CloudGuard
Returns a list of ConditionMetadataType resources.- Specified by:
listConditionMetadataTypes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataMaskRules
public ListDataMaskRulesResponse listDataMaskRules(ListDataMaskRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.- Specified by:
listDataMaskRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataSourceEvents
public ListDataSourceEventsResponse listDataSourceEvents(ListDataSourceEventsRequest request)
Description copied from interface:CloudGuard
Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.- Specified by:
listDataSourceEvents
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataSources
public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
Description copied from interface:CloudGuard
Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId.List is returned in a DataSourceCollection resource with page of DataSourceSummary resources.
The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listDataSources
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDetectorRecipeDetectorRules
public ListDetectorRecipeDetectorRulesResponse listDetectorRecipeDetectorRules(ListDetectorRecipeDetectorRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.- Specified by:
listDetectorRecipeDetectorRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDetectorRecipes
public ListDetectorRecipesResponse listDetectorRecipes(ListDetectorRecipesRequest request)
Description copied from interface:CloudGuard
Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.The ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListDetectorRecipes on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listDetectorRecipes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDetectorRules
public ListDetectorRulesResponse listDetectorRules(ListDetectorRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.- Specified by:
listDetectorRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDetectors
public ListDetectorsResponse listDetectors(ListDetectorsRequest request)
Description copied from interface:CloudGuard
Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.- Specified by:
listDetectors
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listImpactedResources
public ListImpactedResourcesResponse listImpactedResources(ListImpactedResourcesRequest request)
Description copied from interface:CloudGuard
Returns a list of impacted resources for a problem identified by problemId.- Specified by:
listImpactedResources
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listManagedListTypes
public ListManagedListTypesResponse listManagedListTypes(ListManagedListTypesRequest request)
Description copied from interface:CloudGuard
Returns all managed list types (listType parameter) that Cloud Guard supports.- Specified by:
listManagedListTypes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listManagedLists
public ListManagedListsResponse listManagedLists(ListManagedListsRequest request)
Description copied from interface:CloudGuard
Returns a list of all ManagedList resources in a compartment, identified by compartmentId.The ListManagedLists operation returns only the managed lists in
compartmentId
passed. The list does not include any subcompartments of the compartmentId passed.The parameter `accessLevel` specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListManagedLists on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listManagedLists
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPolicies
public ListPoliciesResponse listPolicies(ListPoliciesRequest request)
Description copied from interface:CloudGuard
Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.- Specified by:
listPolicies
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProblemEndpoints
public ListProblemEndpointsResponse listProblemEndpoints(ListProblemEndpointsRequest request)
Description copied from interface:CloudGuard
Returns a list of endpoints associated with a problem, identified by problemId.- Specified by:
listProblemEndpoints
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProblemEntities
public ListProblemEntitiesResponse listProblemEntities(ListProblemEntitiesRequest request)
Description copied from interface:CloudGuard
Returns a list of entities for a problem.- Specified by:
listProblemEntities
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProblemHistories
public ListProblemHistoriesResponse listProblemHistories(ListProblemHistoriesRequest request)
Description copied from interface:CloudGuard
Returns a list of actions taken on a problem.- Specified by:
listProblemHistories
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProblems
public ListProblemsResponse listProblems(ListProblemsRequest request)
Description copied from interface:CloudGuard
Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.The ListProblems operation returns only the problems in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listProblems
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRecommendations
public ListRecommendationsResponse listRecommendations(ListRecommendationsRequest request)
Description copied from interface:CloudGuard
Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.- Specified by:
listRecommendations
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourcePorts
public ListResourcePortsResponse listResourcePorts(ListResourcePortsRequest request)
Description copied from interface:CloudGuard
Returns the list of open ports associated with the resourceId where resource is an instance- Specified by:
listResourcePorts
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceProfileEndpoints
public ListResourceProfileEndpointsResponse listResourceProfileEndpoints(ListResourceProfileEndpointsRequest request)
Description copied from interface:CloudGuard
Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.- Specified by:
listResourceProfileEndpoints
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceProfileImpactedResources
public ListResourceProfileImpactedResourcesResponse listResourceProfileImpactedResources(ListResourceProfileImpactedResourcesRequest request)
Description copied from interface:CloudGuard
Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.- Specified by:
listResourceProfileImpactedResources
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceProfiles
public ListResourceProfilesResponse listResourceProfiles(ListResourceProfilesRequest request)
Description copied from interface:CloudGuard
Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.The ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListResourceProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listResourceProfiles
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceTypes
public ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest request)
Description copied from interface:CloudGuard
Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.- Specified by:
listResourceTypes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceVulnerabilities
public ListResourceVulnerabilitiesResponse listResourceVulnerabilities(ListResourceVulnerabilitiesRequest request)
Description copied from interface:CloudGuard
Returns the list of vulnerabilities associated with the resourceId where resource is an instance- Specified by:
listResourceVulnerabilities
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResources
public ListResourcesResponse listResources(ListResourcesRequest request)
Description copied from interface:CloudGuard
Returns a list of all resources in a compartmentThe ListResources operation returns only the resources in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListResources on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listResources
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResponderActivities
public ListResponderActivitiesResponse listResponderActivities(ListResponderActivitiesRequest request)
Description copied from interface:CloudGuard
Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.- Specified by:
listResponderActivities
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResponderExecutions
public ListResponderExecutionsResponse listResponderExecutions(ListResponderExecutionsRequest request)
Description copied from interface:CloudGuard
Returns a list of responder executions.A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem.
- Specified by:
listResponderExecutions
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResponderRecipeResponderRules
public ListResponderRecipeResponderRulesResponse listResponderRecipeResponderRules(ListResponderRecipeResponderRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.- Specified by:
listResponderRecipeResponderRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResponderRecipes
public ListResponderRecipesResponse listResponderRecipes(ListResponderRecipesRequest request)
Description copied from interface:CloudGuard
Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.The ListResponderRecipe operation returns only the targets in
compartmentId
passed. The list does not include any subcompartments of the compartmentId passed.The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listResponderRecipes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResponderRules
public ListResponderRulesResponse listResponderRules(ListResponderRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of responder rules for the ResponderRecipe resource identified by responderId.The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.
- Specified by:
listResponderRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSavedQueries
public ListSavedQueriesResponse listSavedQueries(ListSavedQueriesRequest request)
Description copied from interface:CloudGuard
Returns a list of saved queries run in a tenancy.- Specified by:
listSavedQueries
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityPolicies
public ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest request)
Description copied from interface:CloudGuard
Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.- Specified by:
listSecurityPolicies
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityRecipes
public ListSecurityRecipesResponse listSecurityRecipes(ListSecurityRecipesRequest request)
Description copied from interface:CloudGuard
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.- Specified by:
listSecurityRecipes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityZones
public ListSecurityZonesResponse listSecurityZones(ListSecurityZonesRequest request)
Description copied from interface:CloudGuard
Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId.List is contained in a page of SecurityZoneSummary resources.
- Specified by:
listSecurityZones
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSightingEndpoints
public ListSightingEndpointsResponse listSightingEndpoints(ListSightingEndpointsRequest request)
Description copied from interface:CloudGuard
Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.- Specified by:
listSightingEndpoints
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSightingImpactedResources
public ListSightingImpactedResourcesResponse listSightingImpactedResources(ListSightingImpactedResourcesRequest request)
Description copied from interface:CloudGuard
Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.- Specified by:
listSightingImpactedResources
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSightings
public ListSightingsResponse listSightings(ListSightingsRequest request)
Description copied from interface:CloudGuard
For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListSightings on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listSightings
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTactics
public ListTacticsResponse listTactics(ListTacticsRequest request)
Description copied from interface:CloudGuard
Returns a list of TacticSummary resources for a compartment, identified by compartmentId.- Specified by:
listTactics
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetDetectorRecipeDetectorRules
public ListTargetDetectorRecipeDetectorRulesResponse listTargetDetectorRecipeDetectorRules(ListTargetDetectorRecipeDetectorRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of DetectorRule associated with DetectorRecipe within a Target.- Specified by:
listTargetDetectorRecipeDetectorRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetDetectorRecipes
public ListTargetDetectorRecipesResponse listTargetDetectorRecipes(ListTargetDetectorRecipesRequest request)
Description copied from interface:CloudGuard
Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId.The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.
- Specified by:
listTargetDetectorRecipes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetResponderRecipeResponderRules
public ListTargetResponderRecipeResponderRulesResponse listTargetResponderRecipeResponderRules(ListTargetResponderRecipeResponderRulesRequest request)
Description copied from interface:CloudGuard
Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target.List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources.
- Specified by:
listTargetResponderRecipeResponderRules
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargetResponderRecipes
public ListTargetResponderRecipesResponse listTargetResponderRecipes(ListTargetResponderRecipesRequest request)
Description copied from interface:CloudGuard
Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.- Specified by:
listTargetResponderRecipes
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTargets
public ListTargetsResponse listTargets(ListTargetsRequest request)
Description copied from interface:CloudGuard
Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId.By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform ListTargets on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all targets in compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
listTargets
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTechniques
public ListTechniquesResponse listTechniques(ListTechniquesRequest request)
Description copied from interface:CloudGuard
Returns a list of techniques associated with detector rules.- Specified by:
listTechniques
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWlpAgents
public ListWlpAgentsResponse listWlpAgents(ListWlpAgentsRequest request)
Description copied from interface:CloudGuard
Returns a list of WLP agents in a compartment.- Specified by:
listWlpAgents
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:CloudGuard
Returns a list of errors for a work request identified by workRequestId.- Specified by:
listWorkRequestErrors
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:CloudGuard
Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.- Specified by:
listWorkRequestLogs
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:CloudGuard
Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.- Specified by:
listWorkRequests
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeCompartment
public RemoveCompartmentResponse removeCompartment(RemoveCompartmentRequest request)
Description copied from interface:CloudGuard
Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can’t remove the primary compartment that was used to create the security zone.
- Specified by:
removeCompartment
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestRiskScores
public RequestRiskScoresResponse requestRiskScores(RequestRiskScoresRequest request)
Description copied from interface:CloudGuard
Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.- Specified by:
requestRiskScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSecurityScoreSummarizedTrend
public RequestSecurityScoreSummarizedTrendResponse requestSecurityScoreSummarizedTrend(RequestSecurityScoreSummarizedTrendRequest request)
Description copied from interface:CloudGuard
Returns a page of SecurityScoreTrendAggregation resources.These measure the number of resources examined across all regions and compare it with the number of problems detected.
- Specified by:
requestSecurityScoreSummarizedTrend
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSecurityScores
public RequestSecurityScoresResponse requestSecurityScores(RequestSecurityScoresRequest request)
Description copied from interface:CloudGuard
Returns a page of SecurityScoreAggregation resources.These measure the number of resources examined across all regions and compare it with the number of problems detected.
- Specified by:
requestSecurityScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedActivityProblems
public RequestSummarizedActivityProblemsResponse requestSummarizedActivityProblems(RequestSummarizedActivityProblemsRequest request)
Description copied from interface:CloudGuard
Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
The compartmentId to be passed with `accessLevel` and `compartmentIdInSubtree` params has to be the root compartment id (tenant-id) only.
- Specified by:
requestSummarizedActivityProblems
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedProblems
public RequestSummarizedProblemsResponse requestSummarizedProblems(RequestSummarizedProblemsRequest request)
Description copied from interface:CloudGuard
Returns the number of problems matching the key-value pairs in dimensionMap.The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
requestSummarizedProblems
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedResponderExecutions
public RequestSummarizedResponderExecutionsResponse requestSummarizedResponderExecutions(RequestSummarizedResponderExecutionsRequest request)
Description copied from interface:CloudGuard
Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201cNot Authorized\u201d is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.
Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201cNot Authorized\u201d is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.
- Specified by:
requestSummarizedResponderExecutions
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedRiskScores
public RequestSummarizedRiskScoresResponse requestSummarizedRiskScores(RequestSummarizedRiskScoresRequest request)
Description copied from interface:CloudGuard
DEPRECATED- Specified by:
requestSummarizedRiskScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedSecurityScores
public RequestSummarizedSecurityScoresResponse requestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest request)
Description copied from interface:CloudGuard
DEPRECATED- Specified by:
requestSummarizedSecurityScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedTopTrendResourceProfileRiskScores
public RequestSummarizedTopTrendResourceProfileRiskScoresResponse requestSummarizedTopTrendResourceProfileRiskScores(RequestSummarizedTopTrendResourceProfileRiskScoresRequest request)
Description copied from interface:CloudGuard
Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.- Specified by:
requestSummarizedTopTrendResourceProfileRiskScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedTrendProblems
public RequestSummarizedTrendProblemsResponse requestSummarizedTrendProblems(RequestSummarizedTrendProblemsRequest request)
Description copied from interface:CloudGuard
Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period.The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.
The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
requestSummarizedTrendProblems
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedTrendResourceRiskScores
public RequestSummarizedTrendResourceRiskScoresResponse requestSummarizedTrendResourceRiskScores(RequestSummarizedTrendResourceRiskScoresRequest request)
Description copied from interface:CloudGuard
Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.- Specified by:
requestSummarizedTrendResourceRiskScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedTrendResponderExecutions
public RequestSummarizedTrendResponderExecutionsResponse requestSummarizedTrendResponderExecutions(RequestSummarizedTrendResponderExecutionsRequest request)
Description copied from interface:CloudGuard
Returns the number of remediations performed by Responders, for a given time period.The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.
The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
- Specified by:
requestSummarizedTrendResponderExecutions
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestSummarizedTrendSecurityScores
public RequestSummarizedTrendSecurityScoresResponse requestSummarizedTrendSecurityScores(RequestSummarizedTrendSecurityScoresRequest request)
Description copied from interface:CloudGuard
DEPRECATED- Specified by:
requestSummarizedTrendSecurityScores
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
skipBulkResponderExecution
public SkipBulkResponderExecutionResponse skipBulkResponderExecution(SkipBulkResponderExecutionRequest request)
Description copied from interface:CloudGuard
Skips the execution for a bulk of responder executions.- Specified by:
skipBulkResponderExecution
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
skipResponderExecution
public SkipResponderExecutionResponse skipResponderExecution(SkipResponderExecutionRequest request)
Description copied from interface:CloudGuard
Skips the execution of the responder execution.When provided, If-Match is checked against etag values of the resource.
- Specified by:
skipResponderExecution
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
triggerResponder
public TriggerResponderResponse triggerResponder(TriggerResponderRequest request)
Description copied from interface:CloudGuard
Sends the problem identified by problemId to the responder engine, to be processed by rule that\u2019s identified by responderRuleId, in the TriggerResponderDetails resource that\u2019s passed.- Specified by:
triggerResponder
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBulkProblemStatus
public UpdateBulkProblemStatusResponse updateBulkProblemStatus(UpdateBulkProblemStatusRequest request)
Description copied from interface:CloudGuard
Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.- Specified by:
updateBulkProblemStatus
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConfiguration
public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
Description copied from interface:CloudGuard
Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID.The reporting region cannot be updated once created.
- Specified by:
updateConfiguration
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataMaskRule
public UpdateDataMaskRuleResponse updateDataMaskRule(UpdateDataMaskRuleRequest request)
Description copied from interface:CloudGuard
Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.- Specified by:
updateDataMaskRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataSource
public UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)
Description copied from interface:CloudGuard
Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.- Specified by:
updateDataSource
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDetectorRecipe
public UpdateDetectorRecipeResponse updateDetectorRecipe(UpdateDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.- Specified by:
updateDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDetectorRecipeDetectorRule
public UpdateDetectorRecipeDetectorRuleResponse updateDetectorRecipeDetectorRule(UpdateDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Updates a detector rule (DetectorRule resource) identified by detectorRuleId.- Specified by:
updateDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateManagedList
public UpdateManagedListResponse updateManagedList(UpdateManagedListRequest request)
Description copied from interface:CloudGuard
Updates a ManagedList resource, identified by managedList.- Specified by:
updateManagedList
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProblemStatus
public UpdateProblemStatusResponse updateProblemStatus(UpdateProblemStatusRequest request)
Description copied from interface:CloudGuard
Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.- Specified by:
updateProblemStatus
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateResponderRecipe
public UpdateResponderRecipeResponse updateResponderRecipe(UpdateResponderRecipeRequest request)
Description copied from interface:CloudGuard
Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.- Specified by:
updateResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateResponderRecipeResponderRule
public UpdateResponderRecipeResponderRuleResponse updateResponderRecipeResponderRule(UpdateResponderRecipeResponderRuleRequest request)
Description copied from interface:CloudGuard
Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.- Specified by:
updateResponderRecipeResponderRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSavedQuery
public UpdateSavedQueryResponse updateSavedQuery(UpdateSavedQueryRequest request)
Description copied from interface:CloudGuard
Updates a saved query identified by savedQueryId.- Specified by:
updateSavedQuery
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityRecipe
public UpdateSecurityRecipeResponse updateSecurityRecipe(UpdateSecurityRecipeRequest request)
Description copied from interface:CloudGuard
Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.- Specified by:
updateSecurityRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityZone
public UpdateSecurityZoneResponse updateSecurityZone(UpdateSecurityZoneRequest request)
Description copied from interface:CloudGuard
Updates a security zone (SecurityZone resource) identified by securityZoneId.Pass parameters through an UpdateSecurityZoneDetails resource.
- Specified by:
updateSecurityZone
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTarget
public UpdateTargetResponse updateTarget(UpdateTargetRequest request)
Description copied from interface:CloudGuard
Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.- Specified by:
updateTarget
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetDetectorRecipe
public UpdateTargetDetectorRecipeResponse updateTargetDetectorRecipe(UpdateTargetDetectorRecipeRequest request)
Description copied from interface:CloudGuard
Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.- Specified by:
updateTargetDetectorRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetDetectorRecipeDetectorRule
public UpdateTargetDetectorRecipeDetectorRuleResponse updateTargetDetectorRecipeDetectorRule(UpdateTargetDetectorRecipeDetectorRuleRequest request)
Description copied from interface:CloudGuard
Updates the DetectorRule resource identified by targetDetectorRecipeId- Specified by:
updateTargetDetectorRecipeDetectorRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetResponderRecipe
public UpdateTargetResponderRecipeResponse updateTargetResponderRecipe(UpdateTargetResponderRecipeRequest request)
Description copied from interface:CloudGuard
Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId.Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.
- Specified by:
updateTargetResponderRecipe
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTargetResponderRecipeResponderRule
public UpdateTargetResponderRecipeResponderRuleResponse updateTargetResponderRecipeResponderRule(UpdateTargetResponderRecipeResponderRuleRequest request)
Description copied from interface:CloudGuard
Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId.Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.
- Specified by:
updateTargetResponderRecipeResponderRule
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWlpAgent
public UpdateWlpAgentResponse updateWlpAgent(UpdateWlpAgentRequest request)
Description copied from interface:CloudGuard
Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.- Specified by:
updateWlpAgent
in interfaceCloudGuard
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public CloudGuardWaiters getWaiters()
Description copied from interface:CloudGuard
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceCloudGuard
- Returns:
- The service waiters.
-
getPaginators
public CloudGuardPaginators getPaginators()
Description copied from interface:CloudGuard
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in interfaceCloudGuard
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-