Share via

CosmosAsyncUser Class

Package:
com.azure.cosmos
Maven Artifact:
com.azure:azure-cosmos:4.73.0
  • java.lang.Object
    • com.azure.cosmos.CosmosAsyncUser

public class CosmosAsyncUser

The type Cosmos async user.

Method Summary

Modifier and Type Method and Description
Mono<CosmosPermissionResponse> createPermission(CosmosPermissionProperties permissionProperties, CosmosPermissionRequestOptions options)

Creates a permission.
Mono<CosmosUserResponse> delete()

Delete a cosmos user
String getId()

Get the id of the CosmosAsyncUser
CosmosAsyncPermission getPermission(String id)

Get cosmos permission without making a call to backend
CosmosPagedFlux<CosmosPermissionProperties> queryPermissions(String query)

Query for permissions.
CosmosPagedFlux<CosmosPermissionProperties> queryPermissions(String query, CosmosQueryRequestOptions options)

Query for permissions.
Mono<CosmosUserResponse> read()

Reads a cosmos user
CosmosPagedFlux<CosmosPermissionProperties> readAllPermissions()

Reads all permissions.
Mono<CosmosUserResponse> replace(CosmosUserProperties userProperties)

Replace a cosmos user
Mono<CosmosPermissionResponse> upsertPermission(CosmosPermissionProperties permissionProperties, CosmosPermissionRequestOptions options)

Upserts a permission.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createPermission

public Mono<CosmosPermissionResponse> createPermission(CosmosPermissionProperties permissionProperties, CosmosPermissionRequestOptions options)

Creates a permission.

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

Parameters:

permissionProperties - the permission properties to create.
options - the request options.

Returns:

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

delete

public Mono<CosmosUserResponse> delete()

Delete a cosmos user

Returns:

a Mono containing the single resource response with the deleted user or an error.

getId

public String getId()

Get the id of the CosmosAsyncUser

Returns:

the id of the CosmosAsyncUser

getPermission

public CosmosAsyncPermission getPermission(String id)

Get cosmos permission without making a call to backend

Parameters:

id - the id

Returns:

the cosmos permission

queryPermissions

public CosmosPagedFlux<CosmosPermissionProperties> queryPermissions(String query)

Query for permissions.

After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response pages of the obtained permissions. In case of failure the CosmosPagedFlux<T> will error.

Parameters:

query - the query.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of the obtained permissions or an error.

queryPermissions

public CosmosPagedFlux<CosmosPermissionProperties> queryPermissions(String query, CosmosQueryRequestOptions options)

Query for permissions.

After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response pages of the obtained permissions. In case of failure the CosmosPagedFlux<T> will error.

Parameters:

query - the query.
options - the query request options.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of the obtained permissions or an error.

read

public Mono<CosmosUserResponse> read()

Reads a cosmos user

Returns:

a Mono containing the single resource response with the read user or an error.

readAllPermissions

public CosmosPagedFlux<CosmosPermissionProperties> readAllPermissions()

Reads all permissions.

After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response pages of the read permissions. In case of failure the CosmosPagedFlux<T> will error.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of the read permissions or an error.

replace

public Mono<CosmosUserResponse> replace(CosmosUserProperties userProperties)

Replace a cosmos user

Parameters:

userProperties - the user properties to use

Returns:

a Mono containing the single resource response with the replaced user or an error.

upsertPermission

public Mono<CosmosPermissionResponse> upsertPermission(CosmosPermissionProperties permissionProperties, CosmosPermissionRequestOptions options)

Upserts a permission.

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

Parameters:

permissionProperties - the permission properties to upsert.
options - the request options.

Returns:

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

Applies to