# CommissioningRequestMetadata.Builder

public static final class **CommissioningRequestMetadata.Builder** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Builder class to generate `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata` instances.

### Public Constructor Summary

|---|---|
|   | [Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#Builder())() |

### Public Method Summary

|---|---|
| [CommissioningRequestMetadata](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata) | [build](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#build())() Builds a new instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata`. |
| [DeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/DeviceDescriptor) | [getDeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#getDeviceDescriptor())() Returns the device descriptor set on this builder. |
| [NetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/NetworkLocation) | [getNetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#getNetworkLocation())() Returns the network location set on this builder. |
| long | [getPasscode](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#getPasscode())() Returns the passcode set on this builder. |
| [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) | [setDeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#setDeviceDescriptor(com.google.android.gms.home.matter.common.DeviceDescriptor))([DeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/DeviceDescriptor) deviceDescriptor) Sets the device descriptor with information about the device being commissioned. |
| [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) | [setNetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#setNetworkLocation(com.google.android.gms.home.matter.common.NetworkLocation))([NetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/NetworkLocation) networkLocation) Sets the location on the current network at which the commissionable device can be located. |
| [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) | [setPasscode](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder#setPasscode(long))(long passcode) Sets the passcode which can be used to establish a connection to the commissionable device. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Constructors

#### public **Builder** ()

## Public Methods

#### public [CommissioningRequestMetadata](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata) **build**
()

Builds a new instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata`.

##### Throws

| [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException.html) | if the network location, passcode, or device descriptor were not set |
|---|---|

#### public [DeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/DeviceDescriptor)
**getDeviceDescriptor** ()

Returns the device descriptor set on this builder.

#### public [NetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/NetworkLocation)
**getNetworkLocation** ()

Returns the network location set on this builder.

#### public long **getPasscode** ()

Returns the passcode set on this builder.

#### public [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) **setDeviceDescriptor** ([DeviceDescriptor](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/DeviceDescriptor) deviceDescriptor)

Sets the device descriptor with information about the device being commissioned.

##### Returns

- this builder

#### public [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) **setNetworkLocation** ([NetworkLocation](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/common/NetworkLocation) networkLocation)

Sets the location on the current network at which the commissionable device can be
located.

##### Returns

- this builder

#### public [CommissioningRequestMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequestMetadata.Builder) **setPasscode** (long passcode)

Sets the passcode which can be used to establish a connection to the commissionable
device.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the `passcode` is out of the valid range (0x1 - 0x5F5E0FE, inclusive) |
|---|---|