Interface Event
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
EventClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public interface Event extends AutoCloseable
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds.For more information, see Overview of OS Management Hub.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChangeEventCompartmentResponse
changeEventCompartment(ChangeEventCompartmentRequest request)
Moves an event into a different compartment within the same tenancy.DeleteEventResponse
deleteEvent(DeleteEventRequest request)
Deletes the specified event.DeleteEventContentResponse
deleteEventContent(DeleteEventContentRequest request)
Deletes an event content ZIP archive from the service.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)GetEventResponse
getEvent(GetEventRequest request)
Returns information about the specified event.GetEventContentResponse
getEventContent(GetEventContentRequest request)
Returns a ZIP archive with additional information about an event.EventPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.EventWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ImportEventContentResponse
importEventContent(ImportEventContentRequest request)
Uploads an event content ZIP archive from an instance to the service.ListEventsResponse
listEvents(ListEventsRequest request)
Lists events that match the specified criteria, such as compartment, state, and event type.void
refreshClient()
Rebuilds the client from scratch.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’).UpdateEventResponse
updateEvent(UpdateEventRequest request)
Updates the tags for an event.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
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.- Parameters:
region
- The region of the service.
-
setRegion
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
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”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
changeEventCompartment
ChangeEventCompartmentResponse changeEventCompartment(ChangeEventCompartmentRequest request)
Moves an event into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ChangeEventCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeEventCompartment API.
-
deleteEvent
DeleteEventResponse deleteEvent(DeleteEventRequest request)
Deletes the specified event.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/DeleteEventExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEvent API.
-
deleteEventContent
DeleteEventContentResponse deleteEventContent(DeleteEventContentRequest request)
Deletes an event content ZIP archive from the service.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/DeleteEventContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEventContent API.
-
getEvent
GetEventResponse getEvent(GetEventRequest request)
Returns information about the specified event.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/GetEventExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEvent API.
-
getEventContent
GetEventContentResponse getEventContent(GetEventContentRequest request)
Returns a ZIP archive with additional information about an event.The archive content depends on the event type.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/GetEventContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEventContent API.
-
importEventContent
ImportEventContentResponse importEventContent(ImportEventContentRequest request)
Uploads an event content ZIP archive from an instance to the service.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ImportEventContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportEventContent API.
-
listEvents
ListEventsResponse listEvents(ListEventsRequest request)
Lists events that match the specified criteria, such as compartment, state, and event type.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ListEventsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEvents API.
-
updateEvent
UpdateEventResponse updateEvent(UpdateEventRequest request)
Updates the tags for an event.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/UpdateEventExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEvent API.
-
getWaiters
EventWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
EventPaginators 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.- Returns:
- The service paginators.
-
-