com.microsoft.azure.cosmos

Class CosmosContainer

java.lang.Object

com.microsoft.azure.cosmos.CosmosResource

com.microsoft.azure.cosmos.CosmosContainer

public class CosmosContainer
extends CosmosResource

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<CosmosItemResponse>	createItem(Object item) Creates a cosmos item.
reactor.core.publisher.Mono<CosmosItemResponse>	createItem(Object item, CosmosItemRequestOptions options) Creates a cosmos item.
reactor.core.publisher.Mono<CosmosItemResponse>	createItem(Object item, Object partitionKey) Creates a cosmos item.
reactor.core.publisher.Mono<CosmosStoredProcedureResponse>	createStoredProcedure(CosmosStoredProcedureSettings settings, CosmosStoredProcedureRequestOptions options) Creates a cosmos stored procedure.
reactor.core.publisher.Mono<CosmosTriggerResponse>	createTrigger(CosmosTriggerSettings settings, CosmosRequestOptions options) Creates a Cosmos trigger.
reactor.core.publisher.Mono<CosmosUserDefinedFunctionResponse>	createUserDefinedFunction(CosmosUserDefinedFunctionSettings settings, CosmosRequestOptions options) Creates a cosmos user defined function.
reactor.core.publisher.Mono<CosmosContainerResponse>	delete() Deletes the item container After subscription the operation will be performed.
reactor.core.publisher.Mono<CosmosContainerResponse>	delete(CosmosContainerRequestOptions requestOptions) Deletes the item container After subscription the operation will be performed.
CosmosDatabase	getDatabase() Gets the parent Database
CosmosItem	getItem(String id) Gets a CosmosItem object without making a service call
protected String	getParentLink()
protected String	getURIPathSegment()
reactor.core.publisher.Flux<FeedResponse<CosmosItem>>	listItems() Reads all cosmos items in the container.
reactor.core.publisher.Flux<FeedResponse<CosmosItem>>	listItems(FeedOptions options) Reads all cosmos items in a container.
reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>>	listStoredProcedures(FeedOptions options) Reads all cosmos stored procedures in a container.
reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>>	listTriggers(FeedOptions options) Reads all triggers in a container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>>	listUserDefinedFunctions(FeedOptions options) Reads all cosmos user defined functions in the container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosItem>>	queryItems(SqlQuerySpec querySpec, FeedOptions options) Query for documents in a items in a container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosItem>>	queryItems(String query, FeedOptions options) Query for documents in a items in a container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>>	queryStoredProcedures(SqlQuerySpec querySpec, FeedOptions options) Query for stored procedures in a container.
reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>>	queryStoredProcedures(String query, FeedOptions options) Query for stored procedures in a container.
reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>>	queryTriggers(SqlQuerySpec querySpec, FeedOptions options) Query for triggers in the container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>>	queryTriggers(String query, FeedOptions options) Query for triggers in the container After subscription the operation will be performed.
reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>>	queryUserDefinedFunctions(SqlQuerySpec querySpec, FeedOptions options) Query for user defined functions in the container.
reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>>	queryUserDefinedFunctions(String query, FeedOptions options) Query for user defined functions in the container.
reactor.core.publisher.Mono<CosmosContainerResponse>	read() Reads the document container After subscription the operation will be performed.
reactor.core.publisher.Mono<CosmosContainerResponse>	read(CosmosContainerRequestOptions requestOptions) Reads the document container by the container link.
reactor.core.publisher.Mono<CosmosContainerResponse>	replace(CosmosContainerSettings containerSettings, CosmosContainerRequestOptions requestOptions) Replaces a document container.
reactor.core.publisher.Mono<CosmosItemResponse>	upsertItem(Object item, CosmosItemRequestOptions options) Upserts a cosmos item.

Methods inherited from class com.microsoft.azure.cosmos.CosmosResource

getId, setId, validateResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

read

public reactor.core.publisher.Mono<CosmosContainerResponse> read()

Reads the document container After subscription the operation will be performed. The Mono upon successful completion will contain a single cossmos container response with the read container. In case of failure the Mono will error.

Returns:

an Mono containing the single cossmos container response with the read container or an error.

read

public reactor.core.publisher.Mono<CosmosContainerResponse> read(CosmosContainerRequestOptions requestOptions)

Reads the document container by the container link. After subscription the operation will be performed. The Mono upon successful completion will contain a single cossmos container response with the read container. In case of failure the Mono will error.

Returns:

an Mono containing the single cossmos container response with the read container or an error.

delete

public reactor.core.publisher.Mono<CosmosContainerResponse> delete(CosmosContainerRequestOptions requestOptions)

Deletes the item container After subscription the operation will be performed. The Mono upon successful completion will contain a single cossmos container response for the deleted database. In case of failure the Mono will error.

Parameters:

requestOptions - the request options.

Returns:

an Mono containing the single cossmos container response for the deleted database or an error.

delete

public reactor.core.publisher.Mono<CosmosContainerResponse> delete()

Deletes the item container After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos container response for the deleted container. In case of failure the Mono will error.

Returns:

an Mono containing the single cossmos container response for the deleted container or an error.

replace

public reactor.core.publisher.Mono<CosmosContainerResponse> replace(CosmosContainerSettings containerSettings,
                                                                    CosmosContainerRequestOptions requestOptions)

Replaces a document container. After subscription the operation will be performed. The Mono upon successful completion will contain a single cossmos container response with the replaced document container. In case of failure the Mono will error.

Parameters:

containerSettings - the item container settings

requestOptions - the cosmos container request options.

Returns:

an Mono containing the single cossmos container response with the replaced document container or an error.

createItem

public reactor.core.publisher.Mono<CosmosItemResponse> createItem(Object item)

Creates a cosmos item. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created cosmos item. In case of failure the Mono will error.

Parameters:

item - the cosmos item represented as a POJO or cosmos item object.

Returns:

an Mono containing the single resource response with the created cosmos item or an error.

createItem

public reactor.core.publisher.Mono<CosmosItemResponse> createItem(Object item,
                                                                  Object partitionKey)

Creates a cosmos item. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created cosmos item. In case of failure the Mono will error.

Parameters:

item - the cosmos item represented as a POJO or cosmos item object.

partitionKey - the partition key

Returns:

an Mono containing the single resource response with the created cosmos item or an error.

createItem

public reactor.core.publisher.Mono<CosmosItemResponse> createItem(Object item,
                                                                  CosmosItemRequestOptions options)

Creates a cosmos item. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created cosmos item. In case of failure the Mono will error.

Parameters:

item - the cosmos item represented as a POJO or cosmos item object.

options - the request options.

Returns:

an Mono containing the single resource response with the created cosmos item or an error.

upsertItem

public reactor.core.publisher.Mono<CosmosItemResponse> upsertItem(Object item,
                                                                  CosmosItemRequestOptions options)

Upserts a cosmos item. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the upserted item. In case of failure the Mono will error.

Parameters:

item - the item represented as a POJO or Item object to upsert.

options - the request options.

Returns:

an Mono containing the single resource response with the upserted document or an error.

listItems

public reactor.core.publisher.Flux<FeedResponse<CosmosItem>> listItems()

Reads all cosmos items in the container. After subscription the operation will be performed. The Flux will contain one or several feed response of the read cosmos items. In case of failure the Flux will error.

Returns:

an Flux containing one or several feed response pages of the read cosmos items or an error.

listItems

public reactor.core.publisher.Flux<FeedResponse<CosmosItem>> listItems(FeedOptions options)

Reads all cosmos items in a container. After subscription the operation will be performed. The Flux will contain one or several feed response of the read cosmos items. In case of failure the Flux will error.

Parameters:

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the read cosmos items or an error.

queryItems

public reactor.core.publisher.Flux<FeedResponse<CosmosItem>> queryItems(String query,
                                                                        FeedOptions options)

Query for documents in a items in a container After subscription the operation will be performed. The Flux will contain one or several feed response of the obtained items. In case of failure the Flux will error.

Parameters:

query - the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained items or an error.

queryItems

public reactor.core.publisher.Flux<FeedResponse<CosmosItem>> queryItems(SqlQuerySpec querySpec,
                                                                        FeedOptions options)

Query for documents in a items in a container After subscription the operation will be performed. The Flux will contain one or several feed response of the obtained items. In case of failure the Flux will error.

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained items or an error.

getItem

public CosmosItem getItem(String id)

Gets a CosmosItem object without making a service call

Parameters:

id - id of the item

Returns:

a cosmos item

createStoredProcedure

public reactor.core.publisher.Mono<CosmosStoredProcedureResponse> createStoredProcedure(CosmosStoredProcedureSettings settings,
                                                                                        CosmosStoredProcedureRequestOptions options)

Creates a cosmos stored procedure. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos stored procedure response with the created cosmos stored procedure. In case of failure the Mono will error.

Parameters:

settings - the cosmos stored procedure settings.

options - the stored procedure request options.

Returns:

an Mono containing the single cosmos stored procedure resource response or an error.

listStoredProcedures

public reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>> listStoredProcedures(FeedOptions options)

Reads all cosmos stored procedures in a container. After subscription the operation will be performed. The Flux will contain one or several feed response pages of the read cosmos stored procedure settings. In case of failure the Flux will error.

Parameters:

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the read cosmos stored procedures settings or an error.

queryStoredProcedures

public reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>> queryStoredProcedures(String query,
                                                                                                      FeedOptions options)

Query for stored procedures in a container. After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained stored procedures. In case of failure the Flux will error.

Parameters:

query - the the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained stored procedures or an error.

queryStoredProcedures

public reactor.core.publisher.Flux<FeedResponse<CosmosStoredProcedureSettings>> queryStoredProcedures(SqlQuerySpec querySpec,
                                                                                                      FeedOptions options)

Query for stored procedures in a container. After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained stored procedures. In case of failure the Flux will error.

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained stored procedures or an error.

createUserDefinedFunction

public reactor.core.publisher.Mono<CosmosUserDefinedFunctionResponse> createUserDefinedFunction(CosmosUserDefinedFunctionSettings settings,
                                                                                                CosmosRequestOptions options)

Creates a cosmos user defined function. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos user defined function response. In case of failure the Mono will error.

Parameters:

settings - the cosmos user defined function settings

options - the cosmos request options.

Returns:

an Mono containing the single resource response with the created user defined function or an error.

listUserDefinedFunctions

public reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>> listUserDefinedFunctions(FeedOptions options)

Reads all cosmos user defined functions in the container After subscription the operation will be performed. The Flux will contain one or several feed response pages of the read user defined functions. In case of failure the Flux will error.

Parameters:

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the read user defined functions or an error.

queryUserDefinedFunctions

public reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>> queryUserDefinedFunctions(String query,
                                                                                                              FeedOptions options)

Query for user defined functions in the container. After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained user defined functions. In case of failure the Flux will error.

Parameters:

query - the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained user defined functions or an error.

queryUserDefinedFunctions

public reactor.core.publisher.Flux<FeedResponse<CosmosUserDefinedFunctionSettings>> queryUserDefinedFunctions(SqlQuerySpec querySpec,
                                                                                                              FeedOptions options)

Query for user defined functions in the container. After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained user defined functions. In case of failure the Flux will error.

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained user defined functions or an error.

createTrigger

public reactor.core.publisher.Mono<CosmosTriggerResponse> createTrigger(CosmosTriggerSettings settings,
                                                                        CosmosRequestOptions options)

Creates a Cosmos trigger. After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos trigger response In case of failure the Mono will error.

Parameters:

options - the request options.

Returns:

an Mono containing the single resource response with the created trigger or an error.

listTriggers

public reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>> listTriggers(FeedOptions options)

Reads all triggers in a container After subscription the operation will be performed. The Flux will contain one or several feed response pages of the read cosmos trigger settings. In case of failure the Flux will error.

Parameters:

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the read cosmos rigger settings or an error.

queryTriggers

public reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>> queryTriggers(String query,
                                                                                      FeedOptions options)

Query for triggers in the container After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained triggers. In case of failure the Flux will error.

Parameters:

query - the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained triggers or an error.

queryTriggers

public reactor.core.publisher.Flux<FeedResponse<CosmosTriggerSettings>> queryTriggers(SqlQuerySpec querySpec,
                                                                                      FeedOptions options)

Query for triggers in the container After subscription the operation will be performed. The Flux will contain one or several feed response pages of the obtained triggers. In case of failure the Flux will error.

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained triggers or an error.

getDatabase

public CosmosDatabase getDatabase()

Gets the parent Database

Returns:

the (@link CosmosDatabase)

getURIPathSegment

protected String getURIPathSegment()

Specified by:

getURIPathSegment in class CosmosResource

getParentLink

protected String getParentLink()

Specified by:

getParentLink in class CosmosResource