software.amazon.awssdk.services.storagegateway.model

Interface DescribeGatewayInformationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>, SdkBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>, SdkPojo, SdkResponse.Builder, StorageGatewayResponse.Builder

Enclosing class:

DescribeGatewayInformationResponse

public static interface DescribeGatewayInformationResponse.Builder
extends StorageGatewayResponse.Builder, SdkPojo, CopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>

Method Summary

Modifier and Type	Method and Description
DescribeGatewayInformationResponse.Builder	cloudWatchLogGroupARN(String cloudWatchLogGroupARN) The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.
DescribeGatewayInformationResponse.Builder	deprecationDate(String deprecationDate) Date after which this gateway will not receive software updates for new features and bug fixes.
DescribeGatewayInformationResponse.Builder	ec2InstanceId(String ec2InstanceId) The ID of the Amazon EC2 instance that was used to launch the gateway.
DescribeGatewayInformationResponse.Builder	ec2InstanceRegion(String ec2InstanceRegion) The Amazon Web Services Region where the Amazon EC2 instance is located.
DescribeGatewayInformationResponse.Builder	endpointType(String endpointType) The type of endpoint for your gateway.
DescribeGatewayInformationResponse.Builder	gatewayARN(String gatewayARN) Sets the value of the GatewayARN property for this object.
DescribeGatewayInformationResponse.Builder	gatewayCapacity(GatewayCapacity gatewayCapacity) Specifies the size of the gateway's metadata cache.
DescribeGatewayInformationResponse.Builder	gatewayCapacity(String gatewayCapacity) Specifies the size of the gateway's metadata cache.
DescribeGatewayInformationResponse.Builder	gatewayId(String gatewayId) The unique identifier assigned to your gateway during activation.
DescribeGatewayInformationResponse.Builder	gatewayName(String gatewayName) The name you configured for your gateway.
DescribeGatewayInformationResponse.Builder	gatewayNetworkInterfaces(Collection<NetworkInterface> gatewayNetworkInterfaces) A NetworkInterface array that contains descriptions of the gateway network interfaces.
DescribeGatewayInformationResponse.Builder	gatewayNetworkInterfaces(Consumer<NetworkInterface.Builder>... gatewayNetworkInterfaces) A NetworkInterface array that contains descriptions of the gateway network interfaces.
DescribeGatewayInformationResponse.Builder	gatewayNetworkInterfaces(NetworkInterface... gatewayNetworkInterfaces) A NetworkInterface array that contains descriptions of the gateway network interfaces.
DescribeGatewayInformationResponse.Builder	gatewayState(String gatewayState) A value that indicates the operating state of the gateway.
DescribeGatewayInformationResponse.Builder	gatewayTimezone(String gatewayTimezone) A value that indicates the time zone configured for the gateway.
DescribeGatewayInformationResponse.Builder	gatewayType(String gatewayType) The type of the gateway.
DescribeGatewayInformationResponse.Builder	hostEnvironment(HostEnvironment hostEnvironment) The type of hardware or software platform on which the gateway is running.
DescribeGatewayInformationResponse.Builder	hostEnvironment(String hostEnvironment) The type of hardware or software platform on which the gateway is running.
DescribeGatewayInformationResponse.Builder	hostEnvironmentId(String hostEnvironmentId) A unique identifier for the specific instance of the host platform running the gateway.
DescribeGatewayInformationResponse.Builder	lastSoftwareUpdate(String lastSoftwareUpdate) The date on which the last software update was applied to the gateway.
DescribeGatewayInformationResponse.Builder	nextUpdateAvailabilityDate(String nextUpdateAvailabilityDate) The date on which an update to the gateway is available.
DescribeGatewayInformationResponse.Builder	softwareUpdatesEndDate(String softwareUpdatesEndDate) Date after which this gateway will not receive software updates for new features.
DescribeGatewayInformationResponse.Builder	supportedGatewayCapacities(Collection<GatewayCapacity> supportedGatewayCapacities) A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
DescribeGatewayInformationResponse.Builder	supportedGatewayCapacities(GatewayCapacity... supportedGatewayCapacities) A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
DescribeGatewayInformationResponse.Builder	supportedGatewayCapacitiesWithStrings(Collection<String> supportedGatewayCapacities) A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
DescribeGatewayInformationResponse.Builder	supportedGatewayCapacitiesWithStrings(String... supportedGatewayCapacities) A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
DescribeGatewayInformationResponse.Builder	tags(Collection<Tag> tags) A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.
DescribeGatewayInformationResponse.Builder	tags(Consumer<Tag.Builder>... tags) A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.
DescribeGatewayInformationResponse.Builder	tags(Tag... tags) A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.
DescribeGatewayInformationResponse.Builder	vpcEndpoint(String vpcEndpoint) The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

gatewayARN

DescribeGatewayInformationResponse.Builder gatewayARN(String gatewayARN)

Sets the value of the GatewayARN property for this object.

Parameters:

gatewayARN - The new value for the GatewayARN property for this object.

Returns:

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

gatewayId

DescribeGatewayInformationResponse.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.

gatewayName

DescribeGatewayInformationResponse.Builder gatewayName(String gatewayName)

The name you configured for your gateway.

Parameters:

gatewayName - The name you configured for your gateway.

Returns:

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

gatewayTimezone

DescribeGatewayInformationResponse.Builder gatewayTimezone(String gatewayTimezone)

A value that indicates the time zone configured for the gateway.

Parameters:

gatewayTimezone - A value that indicates the time zone configured for the gateway.

Returns:

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

gatewayState

DescribeGatewayInformationResponse.Builder gatewayState(String gatewayState)

A value that indicates the operating state of the gateway.

Parameters:

gatewayState - A value that indicates the operating state of the gateway.

Returns:

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

gatewayNetworkInterfaces

DescribeGatewayInformationResponse.Builder gatewayNetworkInterfaces(Collection<NetworkInterface> gatewayNetworkInterfaces)

A NetworkInterface array that contains descriptions of the gateway network interfaces.

Parameters:

gatewayNetworkInterfaces - A NetworkInterface array that contains descriptions of the gateway network interfaces.

Returns:

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

gatewayNetworkInterfaces

DescribeGatewayInformationResponse.Builder gatewayNetworkInterfaces(NetworkInterface... gatewayNetworkInterfaces)

A NetworkInterface array that contains descriptions of the gateway network interfaces.

Parameters:

gatewayNetworkInterfaces - A NetworkInterface array that contains descriptions of the gateway network interfaces.

Returns:

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

gatewayNetworkInterfaces

DescribeGatewayInformationResponse.Builder gatewayNetworkInterfaces(Consumer<NetworkInterface.Builder>... gatewayNetworkInterfaces)

A NetworkInterface array that contains descriptions of the gateway network interfaces.

This is a convenience method that creates an instance of the NetworkInterface.Builder avoiding the need to create one manually via NetworkInterface.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #gatewayNetworkInterfaces(List).

Parameters:

gatewayNetworkInterfaces - a consumer that will call methods on NetworkInterface.Builder

Returns:

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

See Also:

#gatewayNetworkInterfaces(java.util.Collection)

gatewayType

DescribeGatewayInformationResponse.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.

nextUpdateAvailabilityDate

DescribeGatewayInformationResponse.Builder nextUpdateAvailabilityDate(String nextUpdateAvailabilityDate)

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

Parameters:

nextUpdateAvailabilityDate - The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

Returns:

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

lastSoftwareUpdate

DescribeGatewayInformationResponse.Builder lastSoftwareUpdate(String lastSoftwareUpdate)

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

Parameters:

lastSoftwareUpdate - The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

Returns:

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

ec2InstanceId

DescribeGatewayInformationResponse.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

DescribeGatewayInformationResponse.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.

tags

DescribeGatewayInformationResponse.Builder tags(Collection<Tag> tags)

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Parameters:

tags - A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Returns:

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

tags

DescribeGatewayInformationResponse.Builder tags(Tag... tags)

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Parameters:

tags - A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Returns:

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

tags

DescribeGatewayInformationResponse.Builder tags(Consumer<Tag.Builder>... tags)

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

vpcEndpoint

DescribeGatewayInformationResponse.Builder vpcEndpoint(String vpcEndpoint)

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Parameters:

vpcEndpoint - The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Returns:

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

cloudWatchLogGroupARN

DescribeGatewayInformationResponse.Builder cloudWatchLogGroupARN(String cloudWatchLogGroupARN)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

Parameters:

cloudWatchLogGroupARN - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

Returns:

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

hostEnvironment

DescribeGatewayInformationResponse.Builder hostEnvironment(String hostEnvironment)

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

Parameters:

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

Returns:

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

See Also:

HostEnvironment, HostEnvironment

hostEnvironment

DescribeGatewayInformationResponse.Builder hostEnvironment(HostEnvironment hostEnvironment)

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

Parameters:

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

Returns:

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

See Also:

HostEnvironment, HostEnvironment

endpointType

DescribeGatewayInformationResponse.Builder endpointType(String endpointType)

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

Parameters:

endpointType - The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

Returns:

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

softwareUpdatesEndDate

DescribeGatewayInformationResponse.Builder softwareUpdatesEndDate(String softwareUpdatesEndDate)

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

Parameters:

softwareUpdatesEndDate - Date after which this gateway will not receive software updates for new features.

Returns:

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

deprecationDate

DescribeGatewayInformationResponse.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.

gatewayCapacity

DescribeGatewayInformationResponse.Builder gatewayCapacity(String gatewayCapacity)

Specifies the size of the gateway's metadata cache.

Parameters:

gatewayCapacity - Specifies the size of the gateway's metadata cache.

Returns:

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

See Also:

GatewayCapacity, GatewayCapacity

gatewayCapacity

DescribeGatewayInformationResponse.Builder gatewayCapacity(GatewayCapacity gatewayCapacity)

Specifies the size of the gateway's metadata cache.

Parameters:

gatewayCapacity - Specifies the size of the gateway's metadata cache.

Returns:

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

See Also:

GatewayCapacity, GatewayCapacity

supportedGatewayCapacitiesWithStrings

DescribeGatewayInformationResponse.Builder supportedGatewayCapacitiesWithStrings(Collection<String> supportedGatewayCapacities)

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Parameters:

supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Returns:

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

supportedGatewayCapacitiesWithStrings

DescribeGatewayInformationResponse.Builder supportedGatewayCapacitiesWithStrings(String... supportedGatewayCapacities)

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Parameters:

supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Returns:

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

supportedGatewayCapacities

DescribeGatewayInformationResponse.Builder supportedGatewayCapacities(Collection<GatewayCapacity> supportedGatewayCapacities)

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Parameters:

supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Returns:

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

supportedGatewayCapacities

DescribeGatewayInformationResponse.Builder supportedGatewayCapacities(GatewayCapacity... supportedGatewayCapacities)

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Parameters:

supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Returns:

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

hostEnvironmentId

DescribeGatewayInformationResponse.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.