Class CreateDataGrantRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.dataexchange.model.DataExchangeRequest
-
- software.amazon.awssdk.services.dataexchange.model.CreateDataGrantRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDataGrantRequest.Builder,CreateDataGrantRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataGrantRequest extends DataExchangeRequest implements ToCopyableBuilder<CreateDataGrantRequest.Builder,CreateDataGrantRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDataGrantRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDataGrantRequest.Builderbuilder()Stringdescription()The description of the data grant.InstantendsAt()The timestamp of when access to the associated data set ends.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)GrantDistributionScopegrantDistributionScope()The distribution scope of the data grant.StringgrantDistributionScopeAsString()The distribution scope of the data grant.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()The name of the data grant.StringreceiverPrincipal()The Amazon Web Services account ID of the data grant receiver.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateDataGrantRequest.Builder>serializableBuilderClass()StringsourceDataSetId()The ID of the data set used to create the data grant.Map<String,String>tags()The tags to add to the data grant.CreateDataGrantRequest.BuildertoBuilder()StringtoString()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
-
name
public final String name()
The name of the data grant.
- Returns:
- The name of the data grant.
-
grantDistributionScope
public final GrantDistributionScope grantDistributionScope()
The distribution scope of the data grant.
If the service returns an enum value that is not available in the current SDK version,
grantDistributionScopewill returnGrantDistributionScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgrantDistributionScopeAsString().- Returns:
- The distribution scope of the data grant.
- See Also:
GrantDistributionScope
-
grantDistributionScopeAsString
public final String grantDistributionScopeAsString()
The distribution scope of the data grant.
If the service returns an enum value that is not available in the current SDK version,
grantDistributionScopewill returnGrantDistributionScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgrantDistributionScopeAsString().- Returns:
- The distribution scope of the data grant.
- See Also:
GrantDistributionScope
-
receiverPrincipal
public final String receiverPrincipal()
The Amazon Web Services account ID of the data grant receiver.
- Returns:
- The Amazon Web Services account ID of the data grant receiver.
-
sourceDataSetId
public final String sourceDataSetId()
The ID of the data set used to create the data grant.
- Returns:
- The ID of the data set used to create the data grant.
-
endsAt
public final Instant endsAt()
The timestamp of when access to the associated data set ends.
- Returns:
- The timestamp of when access to the associated data set ends.
-
description
public final String description()
The description of the data grant.
- Returns:
- The description of the data grant.
-
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 theisEmpty()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 Map<String,String> tags()
The tags to add to the data grant. A tag is a key-value pair.
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 tags to add to the data grant. A tag is a key-value pair.
-
toBuilder
public CreateDataGrantRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDataGrantRequest.Builder,CreateDataGrantRequest>- Specified by:
toBuilderin classDataExchangeRequest
-
builder
public static CreateDataGrantRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDataGrantRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-