Package software.amazon.awssdk.services.licensemanager.model

Class CreateGrantRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.licensemanager.model.LicenseManagerRequest

software.amazon.awssdk.services.licensemanager.model.CreateGrantRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateGrantRequest
extends LicenseManagerRequest
implements ToCopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateGrantRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<AllowedOperation>	allowedOperations()	Allowed operations for the grant.
List<String>	allowedOperationsAsStrings()	Allowed operations for the grant.
static CreateGrantRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	grantName()	Grant name.
boolean	hasAllowedOperations()	For responses, this returns true if the service returned a value for the AllowedOperations property.
int	hashCode()
boolean	hasPrincipals()	For responses, this returns true if the service returned a value for the Principals property.
String	homeRegion()	Home Region of the grant.
String	licenseArn()	Amazon Resource Name (ARN) of the license.
List<String>	principals()	The grant principals.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGrantRequest.Builder>	serializableBuilderClass()
CreateGrantRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

grantName

public final String grantName()

Grant name.

Returns:

Grant name.

licenseArn

public final String licenseArn()

Amazon Resource Name (ARN) of the license.

Returns:

Amazon Resource Name (ARN) of the license.

hasPrincipals

public final boolean hasPrincipals()

For responses, this returns true if the service returned a value for the Principals 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.

principals

public final List<String> principals()

The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

• An Amazon Web Services account, which includes only the account specified.

• An organizational unit (OU), which includes all accounts in the OU.

• An organization, which will include all accounts across your organization.

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 hasPrincipals() method.

Returns:

The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

• An Amazon Web Services account, which includes only the account specified.

• An organizational unit (OU), which includes all accounts in the OU.

• An organization, which will include all accounts across your organization.

homeRegion

public final String homeRegion()

Home Region of the grant.

Returns:

Home Region of the grant.

allowedOperations

public final List<AllowedOperation> allowedOperations()

Allowed operations for the grant.

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 hasAllowedOperations() method.

Returns:

Allowed operations for the grant.

hasAllowedOperations

public final boolean hasAllowedOperations()

For responses, this returns true if the service returned a value for the AllowedOperations 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.

allowedOperationsAsStrings

public final List<String> allowedOperationsAsStrings()

Allowed operations for the grant.

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 hasAllowedOperations() method.

Returns:

Allowed operations for the grant.

toBuilder

public CreateGrantRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>

Specified by:

toBuilder in class LicenseManagerRequest

builder

public static CreateGrantRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGrantRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo