Bucket (AWS Java SDK :: Services :: Amazon Lightsail 2.21.12 API)

java.lang.Object
- software.amazon.awssdk.services.lightsail.model.Bucket

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Bucket.Builder,Bucket>

@Generated(value="software.amazon.awssdk:codegen")
public final class Bucket
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Bucket.Builder,Bucket>

Describes an Amazon Lightsail bucket.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Bucket.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Bucket.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`ableToUpdateBundle()` Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
`BucketAccessLogConfig`	`accessLogConfig()` An object that describes the access log configuration for the bucket.
`AccessRules`	`accessRules()` An object that describes the access rules of the bucket.
`String`	`arn()` The Amazon Resource Name (ARN) of the bucket.
`static Bucket.Builder`	`builder()`
`String`	`bundleId()` The ID of the bundle currently applied to the bucket.
`Instant`	`createdAt()` The timestamp when the distribution was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReadonlyAccessAccounts()` For responses, this returns true if the service returned a value for the ReadonlyAccessAccounts property.
`boolean`	`hasResourcesReceivingAccess()` For responses, this returns true if the service returned a value for the ResourcesReceivingAccess property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`ResourceLocation`	`location()` An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
`String`	`name()` The name of the bucket.
`String`	`objectVersioning()` Indicates whether object versioning is enabled for the bucket.
`List<String>`	`readonlyAccessAccounts()` An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
`List<ResourceReceivingAccess>`	`resourcesReceivingAccess()` An array of objects that describe Lightsail instances that have access to the bucket.
`String`	`resourceType()` The Lightsail resource type of the bucket (for example, `Bucket`).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Bucket.Builder>`	`serializableBuilderClass()`
`BucketState`	`state()` An object that describes the state of the bucket.
`String`	`supportCode()` The support code for a bucket.
`List<Tag>`	`tags()` The tag keys and optional values for the bucket.
`Bucket.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`url()` The URL of the bucket.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - resourceType
```
public final String resourceType()
```
    The Lightsail resource type of the bucket (for example, Bucket).
    
    Returns:
    
    The Lightsail resource type of the bucket (for example, Bucket).
  - accessRules
```
public final AccessRules accessRules()
```
    An object that describes the access rules of the bucket.
    
    Returns:
    
    An object that describes the access rules of the bucket.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket.
  - bundleId
```
public final String bundleId()
```
    The ID of the bundle currently applied to the bucket.
    
    A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
    
    Use the UpdateBucketBundle action to change the bundle of a bucket.
    
    Returns:
    
    The ID of the bundle currently applied to the bucket.
    
    A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
    
    Use the UpdateBucketBundle action to change the bundle of a bucket.
  - createdAt
```
public final Instant createdAt()
```
    The timestamp when the distribution was created.
    
    Returns:
    
    The timestamp when the distribution was created.
  - url
```
public final String url()
```
    The URL of the bucket.
    
    Returns:
    
    The URL of the bucket.
  - location
```
public final ResourceLocation location()
```
    An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
    
    Returns:
    
    An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
  - name
```
public final String name()
```
    The name of the bucket.
    
    Returns:
    
    The name of the bucket.
  - supportCode
```
public final String supportCode()
```
    The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.
  - objectVersioning
```
public final String objectVersioning()
```
    Indicates whether object versioning is enabled for the bucket.
    
    The following options can be configured:
    - Enabled - Object versioning is enabled.
    - Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
    - NeverEnabled - Object versioning has never been enabled.
    Returns:
    Indicates whether object versioning is enabled for the bucket.
    
    The following options can be configured:
    
    Enabled - Object versioning is enabled.
    
    Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
    
    NeverEnabled - Object versioning has never been enabled.
  - ableToUpdateBundle
```
public final Boolean ableToUpdateBundle()
```
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
    
    You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.
    
    Use the UpdateBucketBundle action to change a bucket's bundle.
    
    Returns:
    
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
    
    You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.
    
    Use the UpdateBucketBundle action to change a bucket's bundle.
  - hasReadonlyAccessAccounts
```
public final boolean hasReadonlyAccessAccounts()
```
    For responses, this returns true if the service returned a value for the ReadonlyAccessAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readonlyAccessAccounts
```
public final List<String> readonlyAccessAccounts()
```
    An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReadonlyAccessAccounts() method.
    
    Returns:
    
    An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
  - hasResourcesReceivingAccess
```
public final boolean hasResourcesReceivingAccess()
```
    For responses, this returns true if the service returned a value for the ResourcesReceivingAccess property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - resourcesReceivingAccess
```
public final List<ResourceReceivingAccess> resourcesReceivingAccess()
```
    An array of objects that describe Lightsail instances that have access to the bucket.
    
    Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourcesReceivingAccess() method.
    
    Returns:
    
    An array of objects that describe Lightsail instances that have access to the bucket.
    
    Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.
  - state
```
public final BucketState state()
```
    An object that describes the state of the bucket.
    
    Returns:
    
    An object that describes the state of the bucket.
  - accessLogConfig
```
public final BucketAccessLogConfig accessLogConfig()
```
    An object that describes the access log configuration for the bucket.
    
    Returns:
    
    An object that describes the access log configuration for the bucket.
  - toBuilder
```
public Bucket.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Bucket.Builder,Bucket>
  - builder
```
public static Bucket.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Bucket.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Bucket

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

resourceType

accessRules

arn

bundleId

createdAt

url

location

name

supportCode

hasTags

tags

objectVersioning

ableToUpdateBundle

hasReadonlyAccessAccounts

readonlyAccessAccounts

hasResourcesReceivingAccess

resourcesReceivingAccess

state

accessLogConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields