Class ApiMetadata.Builder

  • Enclosing class:
    ApiMetadata

    public static class ApiMetadata.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • serviceName

        public ApiMetadata.Builder serviceName​(String serviceName)
        The service Name to which the api belongs to.
        Parameters:
        serviceName - the value to set
        Returns:
        this builder
      • displayName

        public ApiMetadata.Builder displayName​(String displayName)
        The operation Name of the api.

        The name must be unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • path

        public ApiMetadata.Builder path​(String path)
        rest path of the api.
        Parameters:
        path - the value to set
        Returns:
        this builder
      • entityType

        public ApiMetadata.Builder entityType​(String entityType)
        ResourceType to which the apiMetadata belongs to.
        Parameters:
        entityType - the value to set
        Returns:
        this builder
      • apiName

        public ApiMetadata.Builder apiName​(String apiName)
        The name of the api to execute the api request.
        Parameters:
        apiName - the value to set
        Returns:
        this builder
      • fields

        public ApiMetadata.Builder fields​(List<String> fields)
        List of the fields that is use while calling post or put for the data.
        Parameters:
        fields - the value to set
        Returns:
        this builder
      • timeCreated

        public ApiMetadata.Builder timeCreated​(Date timeCreated)
        The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • timeUpdated

        public ApiMetadata.Builder timeUpdated​(Date timeUpdated)
        The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder
      • timeDeleted

        public ApiMetadata.Builder timeDeleted​(Date timeDeleted)
        The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeDeleted - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public ApiMetadata.Builder lifecycleDetails​(String lifecycleDetails)
        A message that describes the current state of the ApiMetadata in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

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

        public ApiMetadata.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. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

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

        public ApiMetadata.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
      • systemTags

        public ApiMetadata.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder