Package com.oracle.bmc.apigateway.model

Class Gateway.Builder

  • Enclosing class:
    Gateway
    public static class Gateway.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Gateway.Builder id​(String id)
        The OCID of the resource.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Gateway.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Example: My new resource

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

      • compartmentId

        public Gateway.Builder compartmentId​(String compartmentId)
        The OCID of the compartment in which the resource is created.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • endpointType

        public Gateway.Builder endpointType​(Gateway.EndpointType endpointType)
        Gateway endpoint type.

        PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

        Example: PUBLIC or PRIVATE

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

      • subnetId

        public Gateway.Builder subnetId​(String subnetId)
        The OCID of the subnet in which related resources are created.
        Parameters:
        subnetId - the value to set
        Returns:
        this builder

      • networkSecurityGroupIds

        public Gateway.Builder networkSecurityGroupIds​(List<String> networkSecurityGroupIds)
        An array of Network Security Groups OCIDs associated with this API Gateway.
        Parameters:
        networkSecurityGroupIds - the value to set
        Returns:
        this builder

      • timeCreated

        public Gateway.Builder timeCreated​(Date timeCreated)
        The time this resource was created.

        An RFC3339 formatted datetime string.

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

      • timeUpdated

        public Gateway.Builder timeUpdated​(Date timeUpdated)
        The time this resource was last updated.

        An RFC3339 formatted datetime string.

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

      • lifecycleState

        public Gateway.Builder lifecycleState​(Gateway.LifecycleState lifecycleState)
        The current state of the gateway.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Gateway.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state in more detail.

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

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

      • locks

        public Gateway.Builder locks​(List<ResourceLock> locks)
        Locks associated with this resource.
        Parameters:
        locks - the value to set
        Returns:
        this builder

      • hostname

        public Gateway.Builder hostname​(String hostname)
        The hostname for APIs deployed on the gateway.
        Parameters:
        hostname - the value to set
        Returns:
        this builder

      • certificateId

        public Gateway.Builder certificateId​(String certificateId)
        The OCID of the resource.
        Parameters:
        certificateId - the value to set
        Returns:
        this builder

      • ipAddresses

        public Gateway.Builder ipAddresses​(List<IpAddress> ipAddresses)
        An array of IP addresses associated with the gateway.
        Parameters:
        ipAddresses - the value to set
        Returns:
        this builder

      • freeformTags

        public Gateway.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 Gateway.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 Gateway.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

      • caBundles

        public Gateway.Builder caBundles​(List<CaBundle> caBundles)
        An array of CA bundles that should be used on the Gateway for TLS validation.
        Parameters:
        caBundles - the value to set
        Returns:
        this builder