Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#inhmethods)

# IkeSaProposal.Builder

*** ** * ** ***

` public static final class IkeSaProposal.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.ipsec.ike.IkeSaProposal.Builder |

<br />

*** ** * ** ***

This class is used to incrementally construct a IkeSaProposal. IkeSaProposal instances are immutable once built.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#Builder()() ` |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#addDhGroup(int)(int dhGroup) ` Adds a Diffie-Hellman Group to the SA proposal being built. |
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#addEncryptionAlgorithm(int,%20int)(int algorithm, int keyLength) ` Adds an encryption algorithm with a specific key length to the SA proposal being built. |
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#addIntegrityAlgorithm(int)(int algorithm) ` Adds an integrity algorithm to the SA proposal being built. |
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#addPseudorandomFunction(int)(int algorithm) ` Adds a pseudorandom function to the SA proposal being built. |
| ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal` | ` https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder#build()() ` Validates and builds the IkeSaProposal. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### Builder

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Builder ()
```

<br />

<br />

## Public methods

### addDhGroup

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IkeSaProposal.Builder addDhGroup (int dhGroup)
```

Adds a Diffie-Hellman Group to the SA proposal being built.

<br />

| Parameters ||
|---|---|
| `dhGroup` | `int`: to add to IkeSaProposal. Value is one of the following: - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_NONE` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_1024_BIT_MODP` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_1536_BIT_MODP` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_2048_BIT_MODP` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_3072_BIT_MODP` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_4096_BIT_MODP` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#DH_GROUP_CURVE_25519` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | Builder of IkeSaProposal. This value cannot be `null`. <br /> |

### addEncryptionAlgorithm

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IkeSaProposal.Builder addEncryptionAlgorithm (int algorithm, 
                int keyLength)
```

Adds an encryption algorithm with a specific key length to the SA proposal being built.

<br />

| Parameters ||
|---|---|
| `algorithm` | `int`: encryption algorithm to add to IkeSaProposal. Value is one of the following: - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_3DES` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_AES_CBC` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_AES_CTR` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_AES_GCM_8` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_AES_GCM_12` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_AES_GCM_16` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#ENCRYPTION_ALGORITHM_CHACHA20_POLY1305` |
| `keyLength` | `int`: key length of algorithm. For algorithms that have fixed key length (e.g. 3DES) only `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#KEY_LEN_UNUSED` is allowed. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | Builder of IkeSaProposal. This value cannot be `null`. <br /> |

### addIntegrityAlgorithm

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IkeSaProposal.Builder addIntegrityAlgorithm (int algorithm)
```

Adds an integrity algorithm to the SA proposal being built.

<br />

| Parameters ||
|---|---|
| `algorithm` | `int`: integrity algorithm to add to IkeSaProposal. Value is one of the following: - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_NONE` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_HMAC_SHA1_96` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_AES_XCBC_96` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_AES_CMAC_96` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_HMAC_SHA2_256_128` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_HMAC_SHA2_384_192` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#INTEGRITY_ALGORITHM_HMAC_SHA2_512_256` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | Builder of IkeSaProposal. This value cannot be `null`. <br /> |

### addPseudorandomFunction

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IkeSaProposal.Builder addPseudorandomFunction (int algorithm)
```

Adds a pseudorandom function to the SA proposal being built.

<br />

| Parameters ||
|---|---|
| `algorithm` | `int`: pseudorandom function to add to IkeSaProposal. Value is one of the following: - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_HMAC_SHA1` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_AES128_XCBC` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_SHA2_256` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_SHA2_384` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_SHA2_512` - `https://developer.android.com/reference/android/net/ipsec/ike/SaProposal#PSEUDORANDOM_FUNCTION_AES128_CMAC` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal.Builder` | Builder of IkeSaProposal. This value cannot be `null`. <br /> |

### build

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IkeSaProposal build ()
```

Validates and builds the IkeSaProposal.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/ipsec/ike/IkeSaProposal` | the validated IkeSaProposal. This value cannot be `null`. <br /> |