public final class CollectionsAsyncClient extends Object
Modifier and Type | Method and Description |
---|---|
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> |
createOrUpdateCollectionWithResponse(String collectionName,
com.azure.core.util.BinaryData collection,
com.azure.core.http.rest.RequestOptions requestOptions)
Creates or updates a collection entity.
|
Mono<com.azure.core.http.rest.Response<Void>> |
deleteCollectionWithResponse(String collectionName,
com.azure.core.http.rest.RequestOptions requestOptions)
Deletes a Collection entity.
|
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> |
getCollectionPathWithResponse(String collectionName,
com.azure.core.http.rest.RequestOptions requestOptions)
Gets the parent name and parent friendly name chains that represent the collection path.
|
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> |
getCollectionWithResponse(String collectionName,
com.azure.core.http.rest.RequestOptions requestOptions)
Get a collection.
|
com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> |
listChildCollectionNames(String collectionName,
com.azure.core.http.rest.RequestOptions requestOptions)
Lists the child collections names in the collection.
|
com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> |
listCollections(com.azure.core.http.rest.RequestOptions requestOptions)
List the collections in the account.
|
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCollectionWithResponse(String collectionName, com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
Response Body Schema
{
collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
description: String
friendlyName: String
name: String
parentCollection: {
referenceName: String
type: String
}
systemData: {
createdAt: String
createdBy: String
createdByType: String(User/Application/ManagedIdentity/Key)
lastModifiedAt: String
lastModifiedBy: String
lastModifiedByType: String(User/Application/ManagedIdentity/Key)
}
}
collectionName
- The collectionName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateCollectionWithResponse(String collectionName, com.azure.core.util.BinaryData collection, com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
Request Body Schema
{
collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
description: String
friendlyName: String
name: String
parentCollection: {
referenceName: String
type: String
}
systemData: {
createdAt: String
createdBy: String
createdByType: String(User/Application/ManagedIdentity/Key)
lastModifiedAt: String
lastModifiedBy: String
lastModifiedByType: String(User/Application/ManagedIdentity/Key)
}
}
Response Body Schema
(recursive schema, see above)
collectionName
- The collectionName parameter.collection
- Collection resource.requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.public Mono<com.azure.core.http.rest.Response<Void>> deleteCollectionWithResponse(String collectionName, com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
collectionName
- The collectionName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listCollections(com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
skipToken | String | No | The skipToken parameter |
Response Body Schema
{
count: Long
nextLink: String
value: [
{
collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
description: String
friendlyName: String
name: String
parentCollection: {
referenceName: String
type: String
}
systemData: {
createdAt: String
createdBy: String
createdByType: String(User/Application/ManagedIdentity/Key)
lastModifiedAt: String
lastModifiedBy: String
lastModifiedByType: String(User/Application/ManagedIdentity/Key)
}
}
]
}
requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listChildCollectionNames(String collectionName, com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
skipToken | String | No | The skipToken parameter |
Response Body Schema
{
count: Long
nextLink: String
value: [
{
friendlyName: String
name: String
}
]
}
collectionName
- The collectionName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCollectionPathWithResponse(String collectionName, com.azure.core.http.rest.RequestOptions requestOptions)
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
apiVersion | String | Yes | Api Version |
Response Body Schema
{
parentFriendlyNameChain: [
String
]
parentNameChain: [
String
]
}
collectionName
- The collectionName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.com.azure.core.exception.HttpResponseException
- thrown if status code is 400 or above, if throwOnError in requestOptions is not
false.Copyright © 2021 Microsoft Corporation. All rights reserved.