CreateRuleRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.vpclattice.model

Class CreateRuleRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.vpclattice.model.CreateRuleRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateRuleRequest ()

Constructors
Constructor and Description
`CreateRuleRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateRuleRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CreateRuleRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CreateRuleRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`RuleAction`	`getAction ()` The action for the default rule.
`String`	`getClientToken ()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`getListenerIdentifier ()` The ID or Amazon Resource Name (ARN) of the listener.
`RuleMatch`	`getMatch ()` The rule match.
`String`	`getName ()` The name of the rule.
`Integer`	`getPriority ()` The priority assigned to the rule.
`String`	`getServiceIdentifier ()` The ID or Amazon Resource Name (ARN) of the service.
`Map<String,String>`	`getTags ()` The tags for the rule.
`int`	`hashCode ()`
`void`	`setAction (RuleAction action)` The action for the default rule.
`void`	`setClientToken (String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setListenerIdentifier (String listenerIdentifier)` The ID or Amazon Resource Name (ARN) of the listener.
`void`	`setMatch (RuleMatch match)` The rule match.
`void`	`setName (String name)` The name of the rule.
`void`	`setPriority (Integer priority)` The priority assigned to the rule.
`void`	`setServiceIdentifier (String serviceIdentifier)` The ID or Amazon Resource Name (ARN) of the service.
`void`	`setTags (Map<String,String> tags)` The tags for the rule.
`String`	`toString ()` Returns a string representation of this object.
`CreateRuleRequest`	`withAction (RuleAction action)` The action for the default rule.
`CreateRuleRequest`	`withClientToken (String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateRuleRequest`	`withListenerIdentifier (String listenerIdentifier)` The ID or Amazon Resource Name (ARN) of the listener.
`CreateRuleRequest`	`withMatch (RuleMatch match)` The rule match.
`CreateRuleRequest`	`withName (String name)` The name of the rule.
`CreateRuleRequest`	`withPriority (Integer priority)` The priority assigned to the rule.
`CreateRuleRequest`	`withServiceIdentifier (String serviceIdentifier)` The ID or Amazon Resource Name (ARN) of the service.
`CreateRuleRequest`	`withTags (Map<String,String> tags)` The tags for the rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateRuleRequest
```
public CreateRuleRequest()
```
- Method Detail
  - setAction
```
public void setAction(RuleAction action)
```
    The action for the default rule.
    
    Parameters:
    
    action - The action for the default rule.
  - getAction
```
public RuleAction getAction()
```
    The action for the default rule.
    
    Returns:
    
    The action for the default rule.
  - withAction
```
public CreateRuleRequest withAction(RuleAction action)
```
    The action for the default rule.
    
    Parameters:
    
    action - The action for the default rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  - getClientToken
```
public String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  - withClientToken
```
public CreateRuleRequest withClientToken(String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setListenerIdentifier
```
public void setListenerIdentifier(String listenerIdentifier)
```
    The ID or Amazon Resource Name (ARN) of the listener.
    
    Parameters:
    
    listenerIdentifier - The ID or Amazon Resource Name (ARN) of the listener.
  - getListenerIdentifier
```
public String getListenerIdentifier()
```
    The ID or Amazon Resource Name (ARN) of the listener.
    
    Returns:
    
    The ID or Amazon Resource Name (ARN) of the listener.
  - withListenerIdentifier
```
public CreateRuleRequest withListenerIdentifier(String listenerIdentifier)
```
    The ID or Amazon Resource Name (ARN) of the listener.
    
    Parameters:
    
    listenerIdentifier - The ID or Amazon Resource Name (ARN) of the listener.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatch
```
public void setMatch(RuleMatch match)
```
    The rule match.
    
    Parameters:
    
    match - The rule match.
  - getMatch
```
public RuleMatch getMatch()
```
    The rule match.
    
    Returns:
    
    The rule match.
  - withMatch
```
public CreateRuleRequest withMatch(RuleMatch match)
```
    The rule match.
    
    Parameters:
    
    match - The rule match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
    
    Parameters:
    
    name - The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  - getName
```
public String getName()
```
    The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
    
    Returns:
    
    The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  - withName
```
public CreateRuleRequest withName(String name)
```
    The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
    
    Parameters:
    
    name - The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
    
    Parameters:
    
    priority - The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
  - getPriority
```
public Integer getPriority()
```
    The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
    
    Returns:
    
    The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
  - withPriority
```
public CreateRuleRequest withPriority(Integer priority)
```
    The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
    
    Parameters:
    
    priority - The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceIdentifier
```
public void setServiceIdentifier(String serviceIdentifier)
```
    The ID or Amazon Resource Name (ARN) of the service.
    
    Parameters:
    
    serviceIdentifier - The ID or Amazon Resource Name (ARN) of the service.
  - getServiceIdentifier
```
public String getServiceIdentifier()
```
    The ID or Amazon Resource Name (ARN) of the service.
    
    Returns:
    
    The ID or Amazon Resource Name (ARN) of the service.
  - withServiceIdentifier
```
public CreateRuleRequest withServiceIdentifier(String serviceIdentifier)
```
    The ID or Amazon Resource Name (ARN) of the service.
    
    Parameters:
    
    serviceIdentifier - The ID or Amazon Resource Name (ARN) of the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags for the rule.
    
    Returns:
    
    The tags for the rule.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags for the rule.
    
    Parameters:
    
    tags - The tags for the rule.
  - withTags
```
public CreateRuleRequest withTags(Map<String,String> tags)
```
    The tags for the rule.
    
    Parameters:
    
    tags - The tags for the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateRuleRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateRuleRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateRuleRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateRuleRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRuleRequest

Method Detail

setAction

getAction

withAction

setClientToken

getClientToken

withClientToken

setListenerIdentifier

getListenerIdentifier

withListenerIdentifier

setMatch

getMatch

withMatch

setName

getName

withName

setPriority

getPriority

withPriority

setServiceIdentifier

getServiceIdentifier

withServiceIdentifier

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone