Class DescribedWebApp
- java.lang.Object
-
- software.amazon.awssdk.services.transfer.model.DescribedWebApp
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DescribedWebApp.Builder,DescribedWebApp>
@Generated("software.amazon.awssdk:codegen") public final class DescribedWebApp extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribedWebApp.Builder,DescribedWebApp>
A structure that describes the parameters for the web app, as identified by the
WebAppId.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribedWebApp.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessEndpoint()TheAccessEndpointis the URL that you provide to your users for them to interact with the Transfer Family web app.Stringarn()The Amazon Resource Name (ARN) of the web app.static DescribedWebApp.Builderbuilder()DescribedWebAppIdentityProviderDetailsdescribedIdentityProviderDetails()A structure that contains the details for the identity provider used by the web app.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribedWebApp.Builder>serializableBuilderClass()List<Tag>tags()Key-value pairs that can be used to group and search for web apps.DescribedWebApp.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringwebAppEndpoint()TheWebAppEndpointis the unique URL for your Transfer Family web app.StringwebAppId()The unique identifier for the web app.WebAppUnitswebAppUnits()A union that contains the value for number of concurrent connections or the user sessions on your web app.-
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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the web app.
- Returns:
- The Amazon Resource Name (ARN) of the web app.
-
webAppId
public final String webAppId()
The unique identifier for the web app.
- Returns:
- The unique identifier for the web app.
-
describedIdentityProviderDetails
public final DescribedWebAppIdentityProviderDetails describedIdentityProviderDetails()
A structure that contains the details for the identity provider used by the web app.
- Returns:
- A structure that contains the details for the identity provider used by the web app.
-
accessEndpoint
public final String accessEndpoint()
The
AccessEndpointis the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.- Returns:
- The
AccessEndpointis the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
-
webAppEndpoint
public final String webAppEndpoint()
The
WebAppEndpointis the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.- Returns:
- The
WebAppEndpointis the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.
-
webAppUnits
public final WebAppUnits webAppUnits()
A union that contains the value for number of concurrent connections or the user sessions on your web app.
- Returns:
- A union that contains the value for number of concurrent connections or the user sessions on your web app.
-
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 List<Tag> tags()
Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.
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:
- Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.
-
toBuilder
public DescribedWebApp.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribedWebApp.Builder,DescribedWebApp>
-
builder
public static DescribedWebApp.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribedWebApp.Builder> serializableBuilderClass()
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-