com.ibm.cos.v2.services.s3.model

Class Grant

java.lang.Object

com.ibm.cos.v2.services.s3.model.Grant

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<Grant.Builder,Grant>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class Grant
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Grant.Builder,Grant>

Container for grant information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Grant.Builder

Method Summary

Modifier and Type	Method and Description
static Grant.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Grantee	grantee() The person being granted permissions.
int	hashCode()
Permission	permission() Specifies the permission given to the grantee.
String	permissionAsString() Specifies the permission given to the grantee.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Grant.Builder>	serializableBuilderClass()
Grant.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

grantee

public final Grantee grantee()

The person being granted permissions.

Returns:

The person being granted permissions.

permission

public final Permission permission()

Specifies the permission given to the grantee.

If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().

Returns:

Specifies the permission given to the grantee.

See Also:

Permission

permissionAsString

public final String permissionAsString()

Specifies the permission given to the grantee.

If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().

Returns:

Specifies the permission given to the grantee.

See Also:

Permission

toBuilder

public Grant.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Grant.Builder,Grant>

Returns:

a builder for type T

builder

public static Grant.Builder builder()

serializableBuilderClass

public static Class<? extends Grant.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.