java.lang.Object
- com.azure.cosmos.models.PartitionKeyBuilder

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class PartitionKeyBuilder
extends Object

Builder for partition keys.

Constructor Summary

Constructors
Constructor Description

PartitionKeyBuilder()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PartitionKeyBuilder`	`add(boolean value)`	Adds partition value of type boolean
`PartitionKeyBuilder`	`add(double value)`	Adds partition value of type double
`PartitionKeyBuilder`	`add(String value)`	Adds partition value of type string
`PartitionKeyBuilder`	`addNoneValue()`	Adds a None Partition Key
`PartitionKeyBuilder`	`addNullValue()`	Adds a null partition key value
`PartitionKey`	`build()`	Builds a new instance of the type PartitionKey with the specified Partition Key values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartitionKeyBuilder

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder()

Constructor. CREATE a new instance of the PartitionKeyBuilder object.

Method Detail

add

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder add(String value)

Adds partition value of type string

Parameters:: value - The value of type string to be used as partition key
Returns:: The current PartitionKeyBuilder object

add

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder add(double value)

Adds partition value of type double

Parameters:: value - The value of type double to be used as partition key
Returns:: The current PartitionKeyBuilder object

add

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder add(boolean value)

Adds partition value of type boolean

Parameters:: value - The value of type boolean to be used as partition key
Returns:: The current PartitionKeyBuilder object

addNullValue

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder addNullValue()

Adds a null partition key value

Returns:: The current PartitionKeyBuilder object

addNoneValue

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKeyBuilder addNoneValue()

Adds a None Partition Key

Returns:: The current PartitionKeyBuilder object

build

@Beta(value=V4_16_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public PartitionKey build()

Builds a new instance of the type PartitionKey with the specified Partition Key values.

Returns:: PartitionKey object

Class PartitionKeyBuilder

Constructor Summary