@Generated(value="OracleSDKGenerator", comments="API Version: 20200131") public interface CloudGuard extends AutoCloseable
Use the Cloud Guard and Security Zones API to automate processes that you would otherwise perform through the Cloud Guard Console or the Security Zones Console. For more information on these services, see the Cloud Guard and Security Zones documentation.
*Note:** For Cloud Guard, you can perform Create, Update, and Delete operations only from the reporting region of your Cloud Guard tenancy. You can perform Read operations from any region.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
AddCompartmentResponse |
addCompartment(AddCompartmentRequest request)
Adds a compartment to an existing security zone (SecurityZone resource), identified by
securityZoneId.
|
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.
|
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).
|
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.
|
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()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetManagedListResponse |
getManagedList(GetManagedListRequest request)
Returns a managed list identified by managedListId.
|
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 resourceId
|
GetResourceProfileResponse |
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 instance
|
GetResponderExecutionResponse |
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 instance
|
ListResourceProfileEndpointsResponse |
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 compartment
|
ListResourceTypesResponse |
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
instance
|
ListResponderActivitiesResponse |
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 |
refreshClient()
Rebuilds the client from scratch.
|
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)
DEPRECATED
|
RequestSummarizedSecurityScoresResponse |
requestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest request)
DEPRECATED
|
RequestSummarizedTopTrendResourceProfileRiskScoresResponse |
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)
DEPRECATED
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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’s identified by responderRuleId, in the TriggerResponderDetails resource
that’s passed.
|
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 targetDetectorRecipeId
|
UpdateTargetResponderRecipeResponse |
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 realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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 call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateAddCompartmentResponse addCompartment(AddCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddCompartment API.
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request identified by workRequestId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelWorkRequest API.
ChangeDataSourceCompartmentResponse changeDataSourceCompartment(ChangeDataSourceCompartmentRequest request)
Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeDataSourceCompartment API.
ChangeDetectorRecipeCompartmentResponse changeDetectorRecipeCompartment(ChangeDetectorRecipeCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeDetectorRecipeCompartment API.
ChangeManagedListCompartmentResponse changeManagedListCompartment(ChangeManagedListCompartmentRequest request)
Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeManagedListCompartment API.
ChangeResponderRecipeCompartmentResponse changeResponderRecipeCompartment(ChangeResponderRecipeCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeResponderRecipeCompartment API.
ChangeSavedQueryCompartmentResponse changeSavedQueryCompartment(ChangeSavedQueryCompartmentRequest request)
Moves the SavedQuery resource into a different compartment. When provided, If-Match is checked against etag values of the resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSavedQueryCompartment API.
ChangeSecurityRecipeCompartmentResponse changeSecurityRecipeCompartment(ChangeSecurityRecipeCompartmentRequest request)
Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the
current compartment to another compartment. When provided, if-match
is checked against
etag
values of the resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSecurityRecipeCompartment API.
ChangeSecurityZoneCompartmentResponse changeSecurityZoneCompartment(ChangeSecurityZoneCompartmentRequest request)
Moves a security zone, identified by securityZoneId, to a different compartment. Pass
parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, if-match
is checked against etag
values of the resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSecurityZoneCompartment API.
CreateAdhocQueryResponse createAdhocQuery(CreateAdhocQueryRequest request)
Creates a AdhocQuery resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateAdhocQuery API.
CreateDataMaskRuleResponse createDataMaskRule(CreateDataMaskRuleRequest request)
Creates a new DataMaskRule resource definition.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataMaskRule API.
CreateDataSourceResponse createDataSource(CreateDataSourceRequest request)
Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataSource API.
CreateDetectorRecipeResponse createDetectorRecipe(CreateDetectorRecipeRequest request)
Creates a new DetectorRecipe resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDetectorRecipe API.
CreateDetectorRecipeDetectorRuleResponse createDetectorRecipeDetectorRule(CreateDetectorRecipeDetectorRuleRequest request)
Creates a detector rule.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDetectorRecipeDetectorRule API.
CreateManagedListResponse createManagedList(CreateManagedListRequest request)
Creates a new ManagedList resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateManagedList API.
CreateResponderRecipeResponse createResponderRecipe(CreateResponderRecipeRequest request)
Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateResponderRecipe API.
CreateSavedQueryResponse createSavedQuery(CreateSavedQueryRequest request)
Creates a SavedQuery resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSavedQuery API.
CreateSecurityRecipeResponse createSecurityRecipe(CreateSecurityRecipeRequest request)
Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSecurityRecipe API.
CreateSecurityZoneResponse createSecurityZone(CreateSecurityZoneRequest request)
Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSecurityZone API.
CreateTargetResponse createTarget(CreateTargetRequest request)
Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTarget API.
CreateTargetDetectorRecipeResponse createTargetDetectorRecipe(CreateTargetDetectorRecipeRequest request)
Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTargetDetectorRecipe API.
CreateTargetResponderRecipeResponse createTargetResponderRecipe(CreateTargetResponderRecipeRequest request)
Attaches a responder recipe to a target.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTargetResponderRecipe API.
CreateWlpAgentResponse createWlpAgent(CreateWlpAgentRequest request)
Creates and registers a WLP agent for an on-premise resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateWlpAgent API.
DeleteAdhocQueryResponse deleteAdhocQuery(DeleteAdhocQueryRequest request)
Deletes a AdhocQuery resource identified by adhocQueryId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteAdhocQuery API.
DeleteDataMaskRuleResponse deleteDataMaskRule(DeleteDataMaskRuleRequest request)
Deletes a DataMaskRule resource, identified by dataMaskRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDataMaskRule API.
DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
Deletes a data source (DataSource resource) identified by dataSourceId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDataSource API.
DeleteDetectorRecipeResponse deleteDetectorRecipe(DeleteDetectorRecipeRequest request)
Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDetectorRecipe API.
DeleteDetectorRecipeDetectorRuleResponse deleteDetectorRecipeDetectorRule(DeleteDetectorRecipeDetectorRuleRequest request)
Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDetectorRecipeDetectorRule API.
DeleteDetectorRecipeDetectorRuleDataSourceResponse deleteDetectorRecipeDetectorRuleDataSource(DeleteDetectorRecipeDetectorRuleDataSourceRequest request)
Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDetectorRecipeDetectorRuleDataSource API.
DeleteManagedListResponse deleteManagedList(DeleteManagedListRequest request)
Deletes a managed list identified by managedListId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteManagedList API.
DeleteResponderRecipeResponse deleteResponderRecipe(DeleteResponderRecipeRequest request)
Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteResponderRecipe API.
DeleteSavedQueryResponse deleteSavedQuery(DeleteSavedQueryRequest request)
Deletes a SavedQuery resource identified by savedQueryId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSavedQuery API.
DeleteSecurityRecipeResponse deleteSecurityRecipe(DeleteSecurityRecipeRequest request)
Deletes a security zone recipe, identified by securityRecipeId. The recipe can’t be associated with an existing security zone.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSecurityRecipe API.
DeleteSecurityZoneResponse deleteSecurityZone(DeleteSecurityZoneRequest request)
Deletes a security zone, identified by securityZoneId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSecurityZone API.
DeleteTargetResponse deleteTarget(DeleteTargetRequest request)
Deletes a target (Target resource) identified by targetId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTarget API.
DeleteTargetDetectorRecipeResponse deleteTargetDetectorRecipe(DeleteTargetDetectorRecipeRequest request)
Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTargetDetectorRecipe API.
DeleteTargetResponderRecipeResponse deleteTargetResponderRecipe(DeleteTargetResponderRecipeRequest request)
Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTargetResponderRecipe API.
DeleteWlpAgentResponse deleteWlpAgent(DeleteWlpAgentRequest request)
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
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteWlpAgent API.
ExecuteResponderExecutionResponse executeResponderExecution(ExecuteResponderExecutionRequest request)
Executes the responder execution. When provided, if-match is checked against etag values of the resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExecuteResponderExecution API.
GetAdhocQueryResponse getAdhocQuery(GetAdhocQueryRequest request)
Returns an adhoc query identified by adhocQueryId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAdhocQuery API.
GetAdhocQueryResultContentResponse getAdhocQueryResultContent(GetAdhocQueryResultContentRequest request)
Downloads the results for a given adhoc ID (from includes results from all monitoring regions).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAdhocQueryResultContent API.
GetConditionMetadataTypeResponse getConditionMetadataType(GetConditionMetadataTypeRequest request)
Returns a ConditionMetatDataType resource with its details.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConditionMetadataType API.
GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConfiguration API.
GetDataMaskRuleResponse getDataMaskRule(GetDataMaskRuleRequest request)
Returns a DataMaskRule resource, identified by dataMaskRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDataMaskRule API.
GetDataSourceResponse getDataSource(GetDataSourceRequest request)
Returns a data source (DataSource resource) identified by dataSourceId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDataSource API.
GetDetectorResponse getDetector(GetDetectorRequest request)
Returns a Detector resource, identified by detectorId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDetector API.
GetDetectorRecipeResponse getDetectorRecipe(GetDetectorRecipeRequest request)
Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDetectorRecipe API.
GetDetectorRecipeDetectorRuleResponse getDetectorRecipeDetectorRule(GetDetectorRecipeDetectorRuleRequest request)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDetectorRecipeDetectorRule API.
GetDetectorRuleResponse getDetectorRule(GetDetectorRuleRequest request)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDetectorRule API.
GetManagedListResponse getManagedList(GetManagedListRequest request)
Returns a managed list identified by managedListId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagedList API.
GetProblemResponse getProblem(GetProblemRequest request)
Returns the Problem resource identified by problemId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetProblem API.
GetResourceResponse getResource(GetResourceRequest request)
Returns a resource identified by resourceId
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResource API.
GetResourceProfileResponse getResourceProfile(GetResourceProfileRequest request)
Returns details for a resource profile, identified by resourceProfileId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResourceProfile API.
GetResourceVulnerabilityResponse getResourceVulnerability(GetResourceVulnerabilityRequest request)
Returns the vulnerability details associated with the cveId where resource is an instance
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResourceVulnerability API.
GetResponderExecutionResponse getResponderExecution(GetResponderExecutionRequest request)
Returns a responder execution identified by responderExecutionId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResponderExecution API.
GetResponderRecipeResponse getResponderRecipe(GetResponderRecipeRequest request)
Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResponderRecipe API.
GetResponderRecipeResponderRuleResponse getResponderRecipeResponderRule(GetResponderRecipeResponderRuleRequest request)
Returns a responder rule (ResponderRule resource) identified by responderRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResponderRecipeResponderRule API.
GetResponderRuleResponse getResponderRule(GetResponderRuleRequest request)
Returns a responder rule (ResponderRule resource) identified by resonderRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResponderRule API.
GetSavedQueryResponse getSavedQuery(GetSavedQueryRequest request)
Returns a SavedQuery resource identified by savedQueryId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSavedQuery API.
GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityPolicy API.
GetSecurityRecipeResponse getSecurityRecipe(GetSecurityRecipeRequest request)
Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityRecipe API.
GetSecurityZoneResponse getSecurityZone(GetSecurityZoneRequest request)
Returns a security zone (SecurityZone resource) identified by securityZoneId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityZone API.
GetSightingResponse getSighting(GetSightingRequest request)
Returns a single sighting (Sighting resource) identified by sightingId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSighting API.
GetTargetResponse getTarget(GetTargetRequest request)
Returns a target (Target resource) identified by targetId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTarget API.
GetTargetDetectorRecipeResponse getTargetDetectorRecipe(GetTargetDetectorRecipeRequest request)
Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTargetDetectorRecipe API.
GetTargetDetectorRecipeDetectorRuleResponse getTargetDetectorRecipeDetectorRule(GetTargetDetectorRecipeDetectorRuleRequest request)
Returns DetectorRule resource by identified by targetDetectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTargetDetectorRecipeDetectorRule API.
GetTargetResponderRecipeResponse getTargetResponderRecipe(GetTargetResponderRecipeRequest request)
Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTargetResponderRecipe API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTargetResponderRecipeResponderRule API.
GetWlpAgentResponse getWlpAgent(GetWlpAgentRequest request)
Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWlpAgent API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Returns details for a work request (WorkRequest resource) identified by workRequestId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListAdhocQueriesResponse listAdhocQueries(ListAdhocQueriesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAdhocQueries API.
ListAdhocQueryResultsResponse listAdhocQueryResults(ListAdhocQueryResultsRequest request)
Lists the results for a given adhoc ID (from includes results from all monitoring regions).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAdhocQueryResults API.
ListConditionMetadataTypesResponse listConditionMetadataTypes(ListConditionMetadataTypesRequest request)
Returns a list of ConditionMetadataType resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConditionMetadataTypes API.
ListDataMaskRulesResponse listDataMaskRules(ListDataMaskRulesRequest request)
Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataMaskRules API.
ListDataSourceEventsResponse listDataSourceEvents(ListDataSourceEventsRequest request)
Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataSourceEvents API.
ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataSources API.
ListDetectorRecipeDetectorRulesResponse listDetectorRecipeDetectorRules(ListDetectorRecipeDetectorRulesRequest request)
Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDetectorRecipeDetectorRules API.
ListDetectorRecipesResponse listDetectorRecipes(ListDetectorRecipesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDetectorRecipes API.
ListDetectorRulesResponse listDetectorRules(ListDetectorRulesRequest request)
Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDetectorRules API.
ListDetectorsResponse listDetectors(ListDetectorsRequest request)
Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDetectors API.
ListImpactedResourcesResponse listImpactedResources(ListImpactedResourcesRequest request)
Returns a list of impacted resources for a problem identified by problemId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListImpactedResources API.
ListManagedListTypesResponse listManagedListTypes(ListManagedListTypesRequest request)
Returns all managed list types (listType parameter) that Cloud Guard supports.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagedListTypes API.
ListManagedListsResponse listManagedLists(ListManagedListsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagedLists API.
ListPoliciesResponse listPolicies(ListPoliciesRequest request)
Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListPolicies API.
ListProblemEndpointsResponse listProblemEndpoints(ListProblemEndpointsRequest request)
Returns a list of endpoints associated with a problem, identified by problemId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProblemEndpoints API.
ListProblemEntitiesResponse listProblemEntities(ListProblemEntitiesRequest request)
Returns a list of entities for a problem.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProblemEntities API.
ListProblemHistoriesResponse listProblemHistories(ListProblemHistoriesRequest request)
Returns a list of actions taken on a problem.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProblemHistories API.
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.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProblems API.
ListRecommendationsResponse listRecommendations(ListRecommendationsRequest request)
Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRecommendations API.
ListResourcePortsResponse listResourcePorts(ListResourcePortsRequest request)
Returns the list of open ports associated with the resourceId where resource is an instance
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourcePorts API.
ListResourceProfileEndpointsResponse listResourceProfileEndpoints(ListResourceProfileEndpointsRequest request)
Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceProfileEndpoints API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceProfileImpactedResources API.
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.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceProfiles API.
ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest request)
Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceTypes API.
ListResourceVulnerabilitiesResponse listResourceVulnerabilities(ListResourceVulnerabilitiesRequest request)
Returns the list of vulnerabilities associated with the resourceId where resource is an instance
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceVulnerabilities API.
ListResourcesResponse listResources(ListResourcesRequest request)
Returns a list of all resources in a compartment
The 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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResources API.
ListResponderActivitiesResponse 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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResponderActivities API.
ListResponderExecutionsResponse listResponderExecutions(ListResponderExecutionsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResponderExecutions API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResponderRecipeResponderRules API.
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. 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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResponderRecipes API.
ListResponderRulesResponse listResponderRules(ListResponderRulesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResponderRules API.
ListSavedQueriesResponse listSavedQueries(ListSavedQueriesRequest request)
Returns a list of saved queries run in a tenancy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSavedQueries API.
ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest request)
Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityPolicies API.
ListSecurityRecipesResponse listSecurityRecipes(ListSecurityRecipesRequest request)
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityRecipes API.
ListSecurityZonesResponse listSecurityZones(ListSecurityZonesRequest request)
Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityZones API.
ListSightingEndpointsResponse listSightingEndpoints(ListSightingEndpointsRequest request)
Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSightingEndpoints API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSightingImpactedResources API.
ListSightingsResponse listSightings(ListSightingsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSightings API.
ListTacticsResponse listTactics(ListTacticsRequest request)
Returns a list of TacticSummary resources for a compartment, identified by compartmentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTactics API.
ListTargetDetectorRecipeDetectorRulesResponse listTargetDetectorRecipeDetectorRules(ListTargetDetectorRecipeDetectorRulesRequest request)
Returns a list of DetectorRule associated with DetectorRecipe within a Target.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTargetDetectorRecipeDetectorRules API.
ListTargetDetectorRecipesResponse listTargetDetectorRecipes(ListTargetDetectorRecipesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTargetDetectorRecipes API.
ListTargetResponderRecipeResponderRulesResponse listTargetResponderRecipeResponderRules(ListTargetResponderRecipeResponderRulesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTargetResponderRecipeResponderRules API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTargetResponderRecipes API.
ListTargetsResponse listTargets(ListTargetsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTargets API.
ListTechniquesResponse listTechniques(ListTechniquesRequest request)
Returns a list of techniques associated with detector rules.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTechniques API.
ListWlpAgentsResponse listWlpAgents(ListWlpAgentsRequest request)
Returns a list of WLP agents in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWlpAgents API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a list of errors for a work request identified by workRequestId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
RemoveCompartmentResponse removeCompartment(RemoveCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveCompartment API.
RequestRiskScoresResponse requestRiskScores(RequestRiskScoresRequest request)
Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestRiskScores API.
RequestSecurityScoreSummarizedTrendResponse requestSecurityScoreSummarizedTrend(RequestSecurityScoreSummarizedTrendRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSecurityScoreSummarizedTrend API.
RequestSecurityScoresResponse requestSecurityScores(RequestSecurityScoresRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSecurityScores API.
RequestSummarizedActivityProblemsResponse requestSummarizedActivityProblems(RequestSummarizedActivityProblemsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedActivityProblems API.
RequestSummarizedProblemsResponse requestSummarizedProblems(RequestSummarizedProblemsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedProblems API.
RequestSummarizedResponderExecutionsResponse requestSummarizedResponderExecutions(RequestSummarizedResponderExecutionsRequest request)
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). “Not Authorized” 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). “Not Authorized” 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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedResponderExecutions API.
RequestSummarizedRiskScoresResponse requestSummarizedRiskScores(RequestSummarizedRiskScoresRequest request)
DEPRECATED
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedRiskScores API.
RequestSummarizedSecurityScoresResponse requestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest request)
DEPRECATED
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedSecurityScores API.
RequestSummarizedTopTrendResourceProfileRiskScoresResponse 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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedTopTrendResourceProfileRiskScores API.
RequestSummarizedTrendProblemsResponse requestSummarizedTrendProblems(RequestSummarizedTrendProblemsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedTrendProblems API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedTrendResourceRiskScores API.
RequestSummarizedTrendResponderExecutionsResponse requestSummarizedTrendResponderExecutions(RequestSummarizedTrendResponderExecutionsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedTrendResponderExecutions API.
RequestSummarizedTrendSecurityScoresResponse requestSummarizedTrendSecurityScores(RequestSummarizedTrendSecurityScoresRequest request)
DEPRECATED
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RequestSummarizedTrendSecurityScores API.
SkipBulkResponderExecutionResponse skipBulkResponderExecution(SkipBulkResponderExecutionRequest request)
Skips the execution for a bulk of responder executions.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SkipBulkResponderExecution API.
SkipResponderExecutionResponse skipResponderExecution(SkipResponderExecutionRequest request)
Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SkipResponderExecution API.
TriggerResponderResponse triggerResponder(TriggerResponderRequest request)
Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use TriggerResponder API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateBulkProblemStatus API.
UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateConfiguration API.
UpdateDataMaskRuleResponse updateDataMaskRule(UpdateDataMaskRuleRequest request)
Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDataMaskRule API.
UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)
Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDataSource API.
UpdateDetectorRecipeResponse updateDetectorRecipe(UpdateDetectorRecipeRequest request)
Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDetectorRecipe API.
UpdateDetectorRecipeDetectorRuleResponse updateDetectorRecipeDetectorRule(UpdateDetectorRecipeDetectorRuleRequest request)
Updates a detector rule (DetectorRule resource) identified by detectorRuleId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDetectorRecipeDetectorRule API.
UpdateManagedListResponse updateManagedList(UpdateManagedListRequest request)
Updates a ManagedList resource, identified by managedList.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateManagedList API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateProblemStatus API.
UpdateResponderRecipeResponse updateResponderRecipe(UpdateResponderRecipeRequest request)
Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateResponderRecipe API.
UpdateResponderRecipeResponderRuleResponse updateResponderRecipeResponderRule(UpdateResponderRecipeResponderRuleRequest request)
Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateResponderRecipeResponderRule API.
UpdateSavedQueryResponse updateSavedQuery(UpdateSavedQueryRequest request)
Updates a saved query identified by savedQueryId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSavedQuery API.
UpdateSecurityRecipeResponse updateSecurityRecipe(UpdateSecurityRecipeRequest request)
Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSecurityRecipe API.
UpdateSecurityZoneResponse updateSecurityZone(UpdateSecurityZoneRequest request)
Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSecurityZone API.
UpdateTargetResponse updateTarget(UpdateTargetRequest request)
Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTarget API.
UpdateTargetDetectorRecipeResponse updateTargetDetectorRecipe(UpdateTargetDetectorRecipeRequest request)
Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTargetDetectorRecipe API.
UpdateTargetDetectorRecipeDetectorRuleResponse updateTargetDetectorRecipeDetectorRule(UpdateTargetDetectorRecipeDetectorRuleRequest request)
Updates the DetectorRule resource identified by targetDetectorRecipeId
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTargetDetectorRecipeDetectorRule API.
UpdateTargetResponderRecipeResponse updateTargetResponderRecipe(UpdateTargetResponderRecipeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTargetResponderRecipe API.
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. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTargetResponderRecipeResponderRule API.
UpdateWlpAgentResponse updateWlpAgent(UpdateWlpAgentRequest request)
Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateWlpAgent API.
CloudGuardWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
CloudGuardPaginators getPaginators()
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.
Copyright © 2016–2024. All rights reserved.