Package software.amazon.awssdk.services.appstream.model

Class DescribeImagePermissionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeImagePermissionsRequest.Builder,DescribeImagePermissionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeImagePermissionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeImagePermissionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSharedAwsAccountIds()	For responses, this returns true if the service returned a value for the SharedAwsAccountIds property.
Integer	maxResults()	The maximum size of each page of results.
String	name()	The name of the private image for which to describe permissions.
String	nextToken()	The pagination token to use to retrieve the next page of results for this operation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeImagePermissionsRequest.Builder>	serializableBuilderClass()
List<String>	sharedAwsAccountIds()	The 12-digit identifier of one or more AWS accounts with which the image is shared.
DescribeImagePermissionsRequest.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

name

public final String name()

The name of the private image for which to describe permissions. The image must be one that you own.

Returns:

The name of the private image for which to describe permissions. The image must be one that you own.

maxResults

public final Integer maxResults()

The maximum size of each page of results.

Returns:

The maximum size of each page of results.

hasSharedAwsAccountIds

public final boolean hasSharedAwsAccountIds()

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

sharedAwsAccountIds

public final List<String> sharedAwsAccountIds()

The 12-digit identifier of one or more AWS accounts with which the image is shared.

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

Returns:

The 12-digit identifier of one or more AWS accounts with which the image is shared.

nextToken

public final String nextToken()

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

toBuilder

public DescribeImagePermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeImagePermissionsRequest.Builder,DescribeImagePermissionsRequest>

Specified by:

toBuilder in class AppStreamRequest

builder

public static DescribeImagePermissionsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo