java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.appmesh.model.AppMeshRequest
    - - software.amazon.awssdk.services.appmesh.model.CreateGatewayRouteRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateGatewayRouteRequest.Builder,CreateGatewayRouteRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateGatewayRouteRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateGatewayRouteRequest.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)`
`String`	`gatewayRouteName()`	The name to use for the gateway route.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`meshName()`	The name of the service mesh to create the gateway route in.
`String`	`meshOwner()`	The Amazon Web Services IAM account ID of the service mesh owner.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateGatewayRouteRequest.Builder>`	`serializableBuilderClass()`
`GatewayRouteSpec`	`spec()`	The gateway route specification to apply.
`List<TagRef>`	`tags()`	Optional metadata that you can apply to the gateway route to assist with categorization and organization.
`CreateGatewayRouteRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`virtualGatewayName()`	The name of the virtual gateway to associate the gateway route with.

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. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
  - gatewayRouteName
```
public final String gatewayRouteName()
```
    The name to use for the gateway route.
    
    Returns:
    
    The name to use for the gateway route.
  - meshName
```
public final String meshName()
```
    The name of the service mesh to create the gateway route in.
    
    Returns:
    
    The name of the service mesh to create the gateway route in.
  - meshOwner
```
public final String meshOwner()
```
    The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
    
    Returns:
    
    The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
  - spec
```
public final GatewayRouteSpec spec()
```
    The gateway route specification to apply.
    
    Returns:
    
    The gateway route specification to apply.
  - 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 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.
  - tags
```
public final List<TagRef> tags()
```
    Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    
    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:
    
    Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - virtualGatewayName
```
public final String virtualGatewayName()
```
    The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
    
    Returns:
    
    The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
  - toBuilder
```
public CreateGatewayRouteRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGatewayRouteRequest.Builder,CreateGatewayRouteRequest>
    
    Specified by:
    
    toBuilder in class AppMeshRequest
  - builder
```
public static CreateGatewayRouteRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGatewayRouteRequest.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

Class CreateGatewayRouteRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

gatewayRouteName

meshName

meshOwner

spec

hasTags

tags

virtualGatewayName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields