Class CloudGuardClient

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for CloudGuard.
      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.
      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.
    • Method Detail

      • setRegion

        public void setRegion​(Region region)
        Description copied from interface: CloudGuard
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Specified by:
        setRegion in interface CloudGuard
        Parameters:
        region - The region of the service.
      • addCompartment

        public AddCompartmentResponse addCompartment​(AddCompartmentRequest request)
        Description copied from interface: CloudGuard
        Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId.

        Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone’s policies.

        Specified by:
        addCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • changeDetectorRecipeCompartment

        public ChangeDetectorRecipeCompartmentResponse changeDetectorRecipeCompartment​(ChangeDetectorRecipeCompartmentRequest request)
        Description copied from interface: CloudGuard
        Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment.

        When provided, If-Match is checked against etag values of the resource.

        Specified by:
        changeDetectorRecipeCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • changeResponderRecipeCompartment

        public ChangeResponderRecipeCompartmentResponse changeResponderRecipeCompartment​(ChangeResponderRecipeCompartmentRequest request)
        Description copied from interface: CloudGuard
        Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.

        When provided, if-match is checked against etag values of the resource.

        Specified by:
        changeResponderRecipeCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • changeSecurityRecipeCompartment

        public ChangeSecurityRecipeCompartmentResponse changeSecurityRecipeCompartment​(ChangeSecurityRecipeCompartmentRequest request)
        Description copied from interface: CloudGuard
        Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment.

        When provided, if-match is checked against etag values of the resource.

        Specified by:
        changeSecurityRecipeCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • changeSecurityZoneCompartment

        public ChangeSecurityZoneCompartmentResponse changeSecurityZoneCompartment​(ChangeSecurityZoneCompartmentRequest request)
        Description copied from interface: CloudGuard
        Moves a security zone, identified by securityZoneId, to a different compartment.

        Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, if-match is checked against etag values of the resource.

        Specified by:
        changeSecurityZoneCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createDataSource

        public CreateDataSourceResponse createDataSource​(CreateDataSourceRequest request)
        Description copied from interface: CloudGuard
        Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.
        Specified by:
        createDataSource in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createResponderRecipe

        public CreateResponderRecipeResponse createResponderRecipe​(CreateResponderRecipeRequest request)
        Description copied from interface: CloudGuard
        Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.
        Specified by:
        createResponderRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createSecurityRecipe

        public CreateSecurityRecipeResponse createSecurityRecipe​(CreateSecurityRecipeRequest request)
        Description copied from interface: CloudGuard
        Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.
        Specified by:
        createSecurityRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createSecurityZone

        public CreateSecurityZoneResponse createSecurityZone​(CreateSecurityZoneRequest request)
        Description copied from interface: CloudGuard
        Creates a security zone (SecurityZone resource) for a compartment.

        Pass parameters through a CreateSecurityZoneDetails resource.

        Specified by:
        createSecurityZone in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createTarget

        public CreateTargetResponse createTarget​(CreateTargetRequest request)
        Description copied from interface: CloudGuard
        Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.
        Specified by:
        createTarget in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createTargetDetectorRecipe

        public CreateTargetDetectorRecipeResponse createTargetDetectorRecipe​(CreateTargetDetectorRecipeRequest request)
        Description copied from interface: CloudGuard
        Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.

        Attach a DetectorRecipe with the Target

        Specified by:
        createTargetDetectorRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • createWlpAgent

        public CreateWlpAgentResponse createWlpAgent​(CreateWlpAgentRequest request)
        Description copied from interface: CloudGuard
        Creates and registers a WLP agent for an on-premise resource.
        Specified by:
        createWlpAgent in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteAdhocQuery

        public DeleteAdhocQueryResponse deleteAdhocQuery​(DeleteAdhocQueryRequest request)
        Description copied from interface: CloudGuard
        Deletes a AdhocQuery resource identified by adhocQueryId.
        Specified by:
        deleteAdhocQuery in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteDataSource

        public DeleteDataSourceResponse deleteDataSource​(DeleteDataSourceRequest request)
        Description copied from interface: CloudGuard
        Deletes a data source (DataSource resource) identified by dataSourceId.
        Specified by:
        deleteDataSource in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteSavedQuery

        public DeleteSavedQueryResponse deleteSavedQuery​(DeleteSavedQueryRequest request)
        Description copied from interface: CloudGuard
        Deletes a SavedQuery resource identified by savedQueryId.
        Specified by:
        deleteSavedQuery in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteSecurityRecipe

        public DeleteSecurityRecipeResponse deleteSecurityRecipe​(DeleteSecurityRecipeRequest request)
        Description copied from interface: CloudGuard
        Deletes a security zone recipe, identified by securityRecipeId.

        The recipe can’t be associated with an existing security zone.

        Specified by:
        deleteSecurityRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteTarget

        public DeleteTargetResponse deleteTarget​(DeleteTargetRequest request)
        Description copied from interface: CloudGuard
        Deletes a target (Target resource) identified by targetId.
        Specified by:
        deleteTarget in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteTargetDetectorRecipe

        public DeleteTargetDetectorRecipeResponse deleteTargetDetectorRecipe​(DeleteTargetDetectorRecipeRequest request)
        Description copied from interface: CloudGuard
        Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.
        Specified by:
        deleteTargetDetectorRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • deleteWlpAgent

        public DeleteWlpAgentResponse deleteWlpAgent​(DeleteWlpAgentRequest request)
        Description copied from interface: CloudGuard
        Deletes and unregisters the WLP agent for an on-premise resource.

        x-obmcs-splat: routing: strategy: route-to-any-ad serviceList: [ ‘cloudguard-cp-SPLAT_ENV’ ] resources: wlpAgent: serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404(‘cloudguard-cp-SPLAT_ENV’, ‘GetWlpAgent’, request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ "WLP_AGENT_DELETE" ] authorization: mode: automated check: resources[‘wlpAgent’].grantedPermissions.contains(‘WLP_AGENT_DELETE’) allowCrossTenancy: true tagStore: mode: automated maximumAttemptCount: 3 throttling: perUserLimit: rpsLimit: 15 perTenantLimit: rpsLimit: 30 quotas: mode: automated search: mode: backfilling operationResourceName: wlpAgent lock: mode: test operationResourceName: wlpAgent

        Specified by:
        deleteWlpAgent in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getAdhocQuery

        public GetAdhocQueryResponse getAdhocQuery​(GetAdhocQueryRequest request)
        Description copied from interface: CloudGuard
        Returns an adhoc query identified by adhocQueryId.
        Specified by:
        getAdhocQuery in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getConfiguration

        public GetConfigurationResponse getConfiguration​(GetConfigurationRequest request)
        Description copied from interface: CloudGuard
        Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
        Specified by:
        getConfiguration in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getDataMaskRule

        public GetDataMaskRuleResponse getDataMaskRule​(GetDataMaskRuleRequest request)
        Description copied from interface: CloudGuard
        Returns a DataMaskRule resource, identified by dataMaskRuleId.
        Specified by:
        getDataMaskRule in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getDataSource

        public GetDataSourceResponse getDataSource​(GetDataSourceRequest request)
        Description copied from interface: CloudGuard
        Returns a data source (DataSource resource) identified by dataSourceId.
        Specified by:
        getDataSource in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getDetector

        public GetDetectorResponse getDetector​(GetDetectorRequest request)
        Description copied from interface: CloudGuard
        Returns a Detector resource, identified by detectorId.
        Specified by:
        getDetector in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getDetectorRecipe

        public GetDetectorRecipeResponse getDetectorRecipe​(GetDetectorRecipeRequest request)
        Description copied from interface: CloudGuard
        Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
        Specified by:
        getDetectorRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getDetectorRule

        public GetDetectorRuleResponse getDetectorRule​(GetDetectorRuleRequest request)
        Description copied from interface: CloudGuard
        Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
        Specified by:
        getDetectorRule in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getManagedList

        public GetManagedListResponse getManagedList​(GetManagedListRequest request)
        Description copied from interface: CloudGuard
        Returns a managed list identified by managedListId.
        Specified by:
        getManagedList in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getProblem

        public GetProblemResponse getProblem​(GetProblemRequest request)
        Description copied from interface: CloudGuard
        Returns the Problem resource identified by problemId.
        Specified by:
        getProblem in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getResource

        public GetResourceResponse getResource​(GetResourceRequest request)
        Description copied from interface: CloudGuard
        Returns a resource identified by resourceId
        Specified by:
        getResource in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getResponderRecipe

        public GetResponderRecipeResponse getResponderRecipe​(GetResponderRecipeRequest request)
        Description copied from interface: CloudGuard
        Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
        Specified by:
        getResponderRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getResponderRule

        public GetResponderRuleResponse getResponderRule​(GetResponderRuleRequest request)
        Description copied from interface: CloudGuard
        Returns a responder rule (ResponderRule resource) identified by resonderRuleId.
        Specified by:
        getResponderRule in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getSavedQuery

        public GetSavedQueryResponse getSavedQuery​(GetSavedQueryRequest request)
        Description copied from interface: CloudGuard
        Returns a SavedQuery resource identified by savedQueryId.
        Specified by:
        getSavedQuery in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getSecurityPolicy

        public GetSecurityPolicyResponse getSecurityPolicy​(GetSecurityPolicyRequest request)
        Description copied from interface: CloudGuard
        Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId).

        When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.

        Specified by:
        getSecurityPolicy in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getSecurityRecipe

        public GetSecurityRecipeResponse getSecurityRecipe​(GetSecurityRecipeRequest request)
        Description copied from interface: CloudGuard
        Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
        Specified by:
        getSecurityRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getSecurityZone

        public GetSecurityZoneResponse getSecurityZone​(GetSecurityZoneRequest request)
        Description copied from interface: CloudGuard
        Returns a security zone (SecurityZone resource) identified by securityZoneId.
        Specified by:
        getSecurityZone in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getSighting

        public GetSightingResponse getSighting​(GetSightingRequest request)
        Description copied from interface: CloudGuard
        Returns a single sighting (Sighting resource) identified by sightingId.
        Specified by:
        getSighting in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getTarget

        public GetTargetResponse getTarget​(GetTargetRequest request)
        Description copied from interface: CloudGuard
        Returns a target (Target resource) identified by targetId.
        Specified by:
        getTarget in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getTargetResponderRecipe

        public GetTargetResponderRecipeResponse getTargetResponderRecipe​(GetTargetResponderRecipeRequest request)
        Description copied from interface: CloudGuard
        Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.
        Specified by:
        getTargetResponderRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getWlpAgent

        public GetWlpAgentResponse getWlpAgent​(GetWlpAgentRequest request)
        Description copied from interface: CloudGuard
        Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.
        Specified by:
        getWlpAgent in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getWorkRequest

        public GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Description copied from interface: CloudGuard
        Returns details for a work request (WorkRequest resource) identified by workRequestId.
        Specified by:
        getWorkRequest in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listAdhocQueries

        public ListAdhocQueriesResponse listAdhocQueries​(ListAdhocQueriesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId.

        List is returned in a AdhocQueryCollection resource with page of AdhocQuerySummary resources.

        The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listAdhocQueries in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDataMaskRules

        public ListDataMaskRulesResponse listDataMaskRules​(ListDataMaskRulesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.
        Specified by:
        listDataMaskRules in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDataSourceEvents

        public ListDataSourceEventsResponse listDataSourceEvents​(ListDataSourceEventsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.
        Specified by:
        listDataSourceEvents in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDataSources

        public ListDataSourcesResponse listDataSources​(ListDataSourcesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId.

        List is returned in a DataSourceCollection resource with page of DataSourceSummary resources.

        The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listDataSources in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDetectorRecipes

        public ListDetectorRecipesResponse listDetectorRecipes​(ListDetectorRecipesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.

        The ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListDetectorRecipes on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listDetectorRecipes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDetectorRules

        public ListDetectorRulesResponse listDetectorRules​(ListDetectorRulesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.
        Specified by:
        listDetectorRules in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listDetectors

        public ListDetectorsResponse listDetectors​(ListDetectorsRequest request)
        Description copied from interface: CloudGuard
        Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.
        Specified by:
        listDetectors in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listManagedLists

        public ListManagedListsResponse listManagedLists​(ListManagedListsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all ManagedList resources in a compartment, identified by compartmentId.

        The ListManagedLists operation returns only the managed lists in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListManagedLists on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listManagedLists in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listPolicies

        public ListPoliciesResponse listPolicies​(ListPoliciesRequest request)
        Description copied from interface: CloudGuard
        Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.
        Specified by:
        listPolicies in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listProblems

        public ListProblemsResponse listProblems​(ListProblemsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.

        The ListProblems operation returns only the problems in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listProblems in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listRecommendations

        public ListRecommendationsResponse listRecommendations​(ListRecommendationsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.
        Specified by:
        listRecommendations in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResourcePorts

        public ListResourcePortsResponse listResourcePorts​(ListResourcePortsRequest request)
        Description copied from interface: CloudGuard
        Returns the list of open ports associated with the resourceId where resource is an instance
        Specified by:
        listResourcePorts in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResourceProfileEndpoints

        public ListResourceProfileEndpointsResponse listResourceProfileEndpoints​(ListResourceProfileEndpointsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.
        Specified by:
        listResourceProfileEndpoints in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResourceProfiles

        public ListResourceProfilesResponse listResourceProfiles​(ListResourceProfilesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.

        The ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListResourceProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listResourceProfiles in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResourceTypes

        public ListResourceTypesResponse listResourceTypes​(ListResourceTypesRequest request)
        Description copied from interface: CloudGuard
        Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.
        Specified by:
        listResourceTypes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResources

        public ListResourcesResponse listResources​(ListResourcesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all resources in a 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.

        Specified by:
        listResources in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResponderActivities

        public ListResponderActivitiesResponse listResponderActivities​(ListResponderActivitiesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.
        Specified by:
        listResponderActivities in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResponderExecutions

        public ListResponderExecutionsResponse listResponderExecutions​(ListResponderExecutionsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of responder executions.

        A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem.

        Specified by:
        listResponderExecutions in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResponderRecipeResponderRules

        public ListResponderRecipeResponderRulesResponse listResponderRecipeResponderRules​(ListResponderRecipeResponderRulesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.
        Specified by:
        listResponderRecipeResponderRules in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResponderRecipes

        public ListResponderRecipesResponse listResponderRecipes​(ListResponderRecipesRequest request)
        Description copied from interface: CloudGuard
        Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.

        The ListResponderRecipe operation returns only the targets in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listResponderRecipes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listResponderRules

        public ListResponderRulesResponse listResponderRules​(ListResponderRulesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of responder rules for the ResponderRecipe resource identified by responderId.

        The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.

        Specified by:
        listResponderRules in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSecurityPolicies

        public ListSecurityPoliciesResponse listSecurityPolicies​(ListSecurityPoliciesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.
        Specified by:
        listSecurityPolicies in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSecurityRecipes

        public ListSecurityRecipesResponse listSecurityRecipes​(ListSecurityRecipesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
        Specified by:
        listSecurityRecipes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSecurityZones

        public ListSecurityZonesResponse listSecurityZones​(ListSecurityZonesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId.

        List is contained in a page of SecurityZoneSummary resources.

        Specified by:
        listSecurityZones in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSightingEndpoints

        public ListSightingEndpointsResponse listSightingEndpoints​(ListSightingEndpointsRequest request)
        Description copied from interface: CloudGuard
        Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.
        Specified by:
        listSightingEndpoints in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listSightings

        public ListSightingsResponse listSightings​(ListSightingsRequest request)
        Description copied from interface: CloudGuard
        For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListSightings on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listSightings in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listTactics

        public ListTacticsResponse listTactics​(ListTacticsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of TacticSummary resources for a compartment, identified by compartmentId.
        Specified by:
        listTactics in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listTargetDetectorRecipes

        public ListTargetDetectorRecipesResponse listTargetDetectorRecipes​(ListTargetDetectorRecipesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId.

        The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.

        Specified by:
        listTargetDetectorRecipes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listTargetResponderRecipes

        public ListTargetResponderRecipesResponse listTargetResponderRecipes​(ListTargetResponderRecipesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.
        Specified by:
        listTargetResponderRecipes in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listTargets

        public ListTargetsResponse listTargets​(ListTargetsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId.

        By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform ListTargets on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all targets in compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        listTargets in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listTechniques

        public ListTechniquesResponse listTechniques​(ListTechniquesRequest request)
        Description copied from interface: CloudGuard
        Returns a list of techniques associated with detector rules.
        Specified by:
        listTechniques in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listWlpAgents

        public ListWlpAgentsResponse listWlpAgents​(ListWlpAgentsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of WLP agents in a compartment.
        Specified by:
        listWlpAgents in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listWorkRequestLogs

        public ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Description copied from interface: CloudGuard
        Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.
        Specified by:
        listWorkRequestLogs in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • listWorkRequests

        public ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Description copied from interface: CloudGuard
        Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.
        Specified by:
        listWorkRequests in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • removeCompartment

        public RemoveCompartmentResponse removeCompartment​(RemoveCompartmentRequest request)
        Description copied from interface: CloudGuard
        Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.

        Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can’t remove the primary compartment that was used to create the security zone.

        Specified by:
        removeCompartment in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestRiskScores

        public RequestRiskScoresResponse requestRiskScores​(RequestRiskScoresRequest request)
        Description copied from interface: CloudGuard
        Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.
        Specified by:
        requestRiskScores in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSecurityScores

        public RequestSecurityScoresResponse requestSecurityScores​(RequestSecurityScoresRequest request)
        Description copied from interface: CloudGuard
        Returns a page of SecurityScoreAggregation resources.

        These measure the number of resources examined across all regions and compare it with the number of problems detected.

        Specified by:
        requestSecurityScores in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSummarizedActivityProblems

        public RequestSummarizedActivityProblemsResponse requestSummarizedActivityProblems​(RequestSummarizedActivityProblemsRequest request)
        Description copied from interface: CloudGuard
        Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        The compartmentId to be passed with `accessLevel` and `compartmentIdInSubtree` params has to be the root compartment id (tenant-id) only.

        Specified by:
        requestSummarizedActivityProblems in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSummarizedProblems

        public RequestSummarizedProblemsResponse requestSummarizedProblems​(RequestSummarizedProblemsRequest request)
        Description copied from interface: CloudGuard
        Returns the number of problems matching the key-value pairs in dimensionMap.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        requestSummarizedProblems in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSummarizedResponderExecutions

        public RequestSummarizedResponderExecutionsResponse requestSummarizedResponderExecutions​(RequestSummarizedResponderExecutionsRequest request)
        Description copied from interface: CloudGuard
        Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.

        Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201cNot Authorized\u201d is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

        Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201cNot Authorized\u201d is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

        Specified by:
        requestSummarizedResponderExecutions in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSummarizedTrendProblems

        public RequestSummarizedTrendProblemsResponse requestSummarizedTrendProblems​(RequestSummarizedTrendProblemsRequest request)
        Description copied from interface: CloudGuard
        Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period.

        The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        requestSummarizedTrendProblems in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • requestSummarizedTrendResponderExecutions

        public RequestSummarizedTrendResponderExecutionsResponse requestSummarizedTrendResponderExecutions​(RequestSummarizedTrendResponderExecutionsRequest request)
        Description copied from interface: CloudGuard
        Returns the number of remediations performed by Responders, for a given time period.

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

        The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        Specified by:
        requestSummarizedTrendResponderExecutions in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • skipResponderExecution

        public SkipResponderExecutionResponse skipResponderExecution​(SkipResponderExecutionRequest request)
        Description copied from interface: CloudGuard
        Skips the execution of the responder execution.

        When provided, If-Match is checked against etag values of the resource.

        Specified by:
        skipResponderExecution in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • triggerResponder

        public TriggerResponderResponse triggerResponder​(TriggerResponderRequest request)
        Description copied from interface: CloudGuard
        Sends the problem identified by problemId to the responder engine, to be processed by rule that\u2019s identified by responderRuleId, in the TriggerResponderDetails resource that\u2019s passed.
        Specified by:
        triggerResponder in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateBulkProblemStatus

        public UpdateBulkProblemStatusResponse updateBulkProblemStatus​(UpdateBulkProblemStatusRequest request)
        Description copied from interface: CloudGuard
        Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.
        Specified by:
        updateBulkProblemStatus in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateConfiguration

        public UpdateConfigurationResponse updateConfiguration​(UpdateConfigurationRequest request)
        Description copied from interface: CloudGuard
        Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID.

        The reporting region cannot be updated once created.

        Specified by:
        updateConfiguration in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateDataMaskRule

        public UpdateDataMaskRuleResponse updateDataMaskRule​(UpdateDataMaskRuleRequest request)
        Description copied from interface: CloudGuard
        Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.
        Specified by:
        updateDataMaskRule in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateDataSource

        public UpdateDataSourceResponse updateDataSource​(UpdateDataSourceRequest request)
        Description copied from interface: CloudGuard
        Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.
        Specified by:
        updateDataSource in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateProblemStatus

        public UpdateProblemStatusResponse updateProblemStatus​(UpdateProblemStatusRequest request)
        Description copied from interface: CloudGuard
        Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.
        Specified by:
        updateProblemStatus in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateResponderRecipe

        public UpdateResponderRecipeResponse updateResponderRecipe​(UpdateResponderRecipeRequest request)
        Description copied from interface: CloudGuard
        Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.
        Specified by:
        updateResponderRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateSecurityRecipe

        public UpdateSecurityRecipeResponse updateSecurityRecipe​(UpdateSecurityRecipeRequest request)
        Description copied from interface: CloudGuard
        Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.
        Specified by:
        updateSecurityRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateSecurityZone

        public UpdateSecurityZoneResponse updateSecurityZone​(UpdateSecurityZoneRequest request)
        Description copied from interface: CloudGuard
        Updates a security zone (SecurityZone resource) identified by securityZoneId.

        Pass parameters through an UpdateSecurityZoneDetails resource.

        Specified by:
        updateSecurityZone in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateTarget

        public UpdateTargetResponse updateTarget​(UpdateTargetRequest request)
        Description copied from interface: CloudGuard
        Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.
        Specified by:
        updateTarget in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateTargetDetectorRecipe

        public UpdateTargetDetectorRecipeResponse updateTargetDetectorRecipe​(UpdateTargetDetectorRecipeRequest request)
        Description copied from interface: CloudGuard
        Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.
        Specified by:
        updateTargetDetectorRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateTargetResponderRecipe

        public UpdateTargetResponderRecipeResponse updateTargetResponderRecipe​(UpdateTargetResponderRecipeRequest request)
        Description copied from interface: CloudGuard
        Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId.

        Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.

        Specified by:
        updateTargetResponderRecipe in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateTargetResponderRecipeResponderRule

        public UpdateTargetResponderRecipeResponderRuleResponse updateTargetResponderRecipeResponderRule​(UpdateTargetResponderRecipeResponderRuleRequest request)
        Description copied from interface: CloudGuard
        Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId.

        Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.

        Specified by:
        updateTargetResponderRecipeResponderRule in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • updateWlpAgent

        public UpdateWlpAgentResponse updateWlpAgent​(UpdateWlpAgentRequest request)
        Description copied from interface: CloudGuard
        Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.
        Specified by:
        updateWlpAgent in interface CloudGuard
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
      • getWaiters

        public CloudGuardWaiters getWaiters()
        Description copied from interface: CloudGuard
        Gets the pre-configured waiters available for resources for this service.
        Specified by:
        getWaiters in interface CloudGuard
        Returns:
        The service waiters.
      • getPaginators

        public CloudGuardPaginators getPaginators()
        Description copied from interface: CloudGuard
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Specified by:
        getPaginators in interface CloudGuard
        Returns:
        The service paginators.
      • useRealmSpecificEndpointTemplate

        public void useRealmSpecificEndpointTemplate​(boolean useOfRealmSpecificEndpointTemplateEnabled)
        This method should be used to enable or disable the use of realm-specific endpoint template.

        The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

        Parameters:
        useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
      • populateServiceParametersInEndpoint

        public final void populateServiceParametersInEndpoint​(String endpoint,
                                                              Map<String,​Object> requiredParametersMap)
        Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

        The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

        Parameters:
        endpoint - The endpoint template in use
        requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
      • updateBaseEndpoint

        public final void updateBaseEndpoint​(String endpoint)
        This method should be used for parameterized endpoint templates only.

        This does not include {region} and {secondLevelDomain} parameters.

        Parameters:
        endpoint - The updated endpoint to use
      • setEndpoint

        public final void setEndpoint​(String endpoint)
      • getEndpoint

        public final String getEndpoint()
      • refreshClient

        public final void refreshClient()
        Rebuild the backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()
      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()