Package software.amazon.awssdk.services.storagegateway.model

Interface GatewayInfo.Builder

    • Method Detail

      • gatewayId

        GatewayInfo.Builder gatewayId​(String gatewayId)

        The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

        Parameters:
        gatewayId - The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gatewayARN

        GatewayInfo.Builder gatewayARN​(String gatewayARN)

        The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

        Parameters:
        gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gatewayType

        GatewayInfo.Builder gatewayType​(String gatewayType)

        The type of the gateway.

        Parameters:
        gatewayType - The type of the gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gatewayOperationalState

        GatewayInfo.Builder gatewayOperationalState​(String gatewayOperationalState)

        The state of the gateway.

        Valid Values: DISABLED | ACTIVE

        Parameters:
        gatewayOperationalState - The state of the gateway.

        Valid Values: DISABLED | ACTIVE

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gatewayName

        GatewayInfo.Builder gatewayName​(String gatewayName)

        The name of the gateway.

        Parameters:
        gatewayName - The name of the gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ec2InstanceId

        GatewayInfo.Builder ec2InstanceId​(String ec2InstanceId)

        The ID of the Amazon EC2 instance that was used to launch the gateway.

        Parameters:
        ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ec2InstanceRegion

        GatewayInfo.Builder ec2InstanceRegion​(String ec2InstanceRegion)

        The Amazon Web Services Region where the Amazon EC2 instance is located.

        Parameters:
        ec2InstanceRegion - The Amazon Web Services Region where the Amazon EC2 instance is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hostEnvironment

        GatewayInfo.Builder hostEnvironment​(String hostEnvironment)

        The type of hardware or software platform on which the gateway is running.

        Tape Gateway is no longer available on Snow Family devices.

        Parameters:
        hostEnvironment - The type of hardware or software platform on which the gateway is running.

        Tape Gateway is no longer available on Snow Family devices.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HostEnvironment, HostEnvironment

      • hostEnvironment

        GatewayInfo.Builder hostEnvironment​(HostEnvironment hostEnvironment)

        The type of hardware or software platform on which the gateway is running.

        Tape Gateway is no longer available on Snow Family devices.

        Parameters:
        hostEnvironment - The type of hardware or software platform on which the gateway is running.

        Tape Gateway is no longer available on Snow Family devices.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HostEnvironment, HostEnvironment

      • hostEnvironmentId

        GatewayInfo.Builder hostEnvironmentId​(String hostEnvironmentId)

        A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

        Parameters:
        hostEnvironmentId - A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deprecationDate

        GatewayInfo.Builder deprecationDate​(String deprecationDate)

        Date after which this gateway will not receive software updates for new features and bug fixes.

        Parameters:
        deprecationDate - Date after which this gateway will not receive software updates for new features and bug fixes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • softwareVersion

        GatewayInfo.Builder softwareVersion​(String softwareVersion)

        The version number of the software running on the gateway appliance.

        Parameters:
        softwareVersion - The version number of the software running on the gateway appliance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.