Class Data.Builder

  • Enclosing class:
    Data

    public static class Data.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • eventGroupingId

        public Data.Builder eventGroupingId​(String eventGroupingId)
        This value links multiple audit events that are part of the same API operation.

        For example, a long running API operations that emit an event at the start and the end of an operation would use the same value in this field for both events.

        Parameters:
        eventGroupingId - the value to set
        Returns:
        this builder
      • eventName

        public Data.Builder eventName​(String eventName)
        Name of the API operation that generated this event.

        Example: GetInstance

        Parameters:
        eventName - the value to set
        Returns:
        this builder
      • compartmentId

        public Data.Builder compartmentId​(String compartmentId)
        The OCID of the compartment of the resource emitting the event.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • compartmentName

        public Data.Builder compartmentName​(String compartmentName)
        The name of the compartment.

        This value is the friendly name associated with compartmentId. This value can change, but the service logs the value that appeared at the time of the audit event.

        Example: CompartmentA

        Parameters:
        compartmentName - the value to set
        Returns:
        this builder
      • resourceName

        public Data.Builder resourceName​(String resourceName)
        The name of the resource emitting the event.
        Parameters:
        resourceName - the value to set
        Returns:
        this builder
      • resourceId

        public Data.Builder resourceId​(String resourceId)
        An OCID or some other ID for the resource emitting the event.
        Parameters:
        resourceId - the value to set
        Returns:
        this builder
      • availabilityDomain

        public Data.Builder availabilityDomain​(String availabilityDomain)
        The availability domain where the resource resides.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder
      • freeformTags

        public Data.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

        public Data.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • additionalDetails

        public Data.Builder additionalDetails​(Map<String,​Object> additionalDetails)
        A container object for attribues unique to the resource emitting the event.

        Example:

        ----- { "imageId": "ocid1.image.oc1.phx.", "shape": "VM.Standard1.1", "type": "CustomerVmi" } -----

        Parameters:
        additionalDetails - the value to set
        Returns:
        this builder
      • build

        public Data build()