ApiKeyRestrictions (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.location.model.ApiKeyRestrictions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ApiKeyRestrictions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>
```
API Restrictions on the allowed actions, resources, and referers for an API key resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ApiKeyRestrictions.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ApiKeyRestrictions.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`allowActions()` A list of allowed actions that an API key resource grants permissions to perform.
`List<String>`	`allowReferers()` An optional list of allowed HTTP referers for which requests must originate from.
`List<String>`	`allowResources()` A list of allowed resource ARNs that a API key bearer can perform actions on.
`static ApiKeyRestrictions.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowActions()` For responses, this returns true if the service returned a value for the AllowActions property.
`boolean`	`hasAllowReferers()` For responses, this returns true if the service returned a value for the AllowReferers property.
`boolean`	`hasAllowResources()` For responses, this returns true if the service returned a value for the AllowResources property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ApiKeyRestrictions.Builder>`	`serializableBuilderClass()`
`ApiKeyRestrictions.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - hasAllowActions
```
public final boolean hasAllowActions()
```
    For responses, this returns true if the service returned a value for the AllowActions 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.
  - allowActions
```
public final List<String> allowActions()
```
    A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
    
    The following are valid values for the actions.
    - Map actions
      
      geo:GetMap* - Allows all actions needed for map rendering.
    - Place actions
      
      geo:SearchPlaceIndexForText - Allows geocoding.
      
      geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
      
      geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
      
      GetPlace - Allows finding a place by place ID.
    - Route actions
      
      geo:CalculateRoute - Allows point to point routing.
      
      geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
    You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.
    
    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 hasAllowActions() method.
    Returns:
    A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
    
    The following are valid values for the actions.
    
    Map actions
    
    geo:GetMap* - Allows all actions needed for map rendering.
    
    Place actions
    
    geo:SearchPlaceIndexForText - Allows geocoding.
    
    geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
    
    geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
    
    GetPlace - Allows finding a place by place ID.
    
    Route actions
    
    geo:CalculateRoute - Allows point to point routing.
    
    geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
    
    You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.
  - hasAllowReferers
```
public final boolean hasAllowReferers()
```
    For responses, this returns true if the service returned a value for the AllowReferers 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.
  - allowReferers
```
public final List<String> allowReferers()
```
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    - May contain wildcard characters question mark (?) and asterisk (*).
      
      Question mark (?) will replace any single character (including hexadecimal digits).
      
      Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    - No spaces allowed. For example, https://example.com.
    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 hasAllowReferers() method.
    Returns:
    An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
    
    May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    
    May contain wildcard characters question mark (?) and asterisk (*).
    
    Question mark (?) will replace any single character (including hexadecimal digits).
    
    Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    
    No spaces allowed. For example, https://example.com.
  - hasAllowResources
```
public final boolean hasAllowResources()
```
    For responses, this returns true if the service returned a value for the AllowResources 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.
  - allowResources
```
public final List<String> allowResources()
```
    A list of allowed resource ARNs that a API key bearer can perform actions on.
    - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
    - The resources must be in the same partition, region, and account-id as the key that is being created.
    - Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id, delimited by colons (:).
    - No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    For more information about ARN format, see Amazon Resource Names (ARNs).
    
    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 hasAllowResources() method.
    Returns:
    A list of allowed resource ARNs that a API key bearer can perform actions on.
    
    The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
    
    The resources must be in the same partition, region, and account-id as the key that is being created.
    
    Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id, delimited by colons (:).
    
    No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    
    For more information about ARN format, see Amazon Resource Names (ARNs).
  - toBuilder
```
public ApiKeyRestrictions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ApiKeyRestrictions.Builder,ApiKeyRestrictions>
  - builder
```
public static ApiKeyRestrictions.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ApiKeyRestrictions.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ApiKeyRestrictions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAllowActions

allowActions

hasAllowReferers

allowReferers

hasAllowResources

allowResources

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields