com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class ObjectsMetadataCatalogOperationsClient

Object

MindsphereAPIClient

ObjectsMetadataCatalogOperationsClient

public class ObjectsMetadataCatalogOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectsMetadataCatalogOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
ObjectsMetadataCatalogOperationsClient(ObjectsMetadataCatalogOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static ObjectsMetadataCatalogOperationsClient.ClientBuilder	builder()
void	createOrUpdateObjectMetadata(CreateOrUpdateObjectMetadataRequest requestObject) Create/Update Metadata for the object.
ObjectMetaDataResponse	retrieveObjectMetadata(RetrieveObjectMetadataRequest requestObject) Get Metadata for the object.

Methods inherited from class Object

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

Constructor Detail

ObjectsMetadataCatalogOperationsClient

public ObjectsMetadataCatalogOperationsClient(ObjectsMetadataCatalogOperationsClient.ClientBuilder builder)

Method Detail

builder

public static ObjectsMetadataCatalogOperationsClient.ClientBuilder builder()

createOrUpdateObjectMetadata

public void createOrUpdateObjectMetadata(CreateOrUpdateObjectMetadataRequest requestObject)
                                  throws MindsphereException

Create/Update Metadata for the object. Create/Update metadata. If tenant is operating for a subtenant object, he should specify subtenant in request query parameter. If path contains special characters which require URL encoding, it should be done as appropriate. Maximum 8 tags are allowed, where each tag can be maximum 128 characters.

201 - Created

204 - No Content

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>parameterPathTooLong</td> <td>Parameter complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>parameterPathInvalid</td> <td>Provided parameter path is invalid.</td> </tr> <tr> <td>tooManyTags</td> <td>More than 8 tags are not allowed.</td> </tr> <tr> <td>tagTooLong</td> <td>Tag length must not be greater than 128 characters.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

0 - Other error with any status code and response body format.

Parameters:

requestObject - - Object of type CreateOrUpdateObjectMetadataRequest {Parameters are path*,metadata*,subtenantId}

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

retrieveObjectMetadata

public ObjectMetaDataResponse retrieveObjectMetadata(RetrieveObjectMetadataRequest requestObject)
                                              throws MindsphereException

Get Metadata for the object. Get Metadata for the object. If tenant is operating for a subtenant object, he should specify subtenant in request query parameter. If path contains special characters which require URL encoding, it should be done as appropriate.

200 - OK

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>parameterPathTooLong</td> <td>Parameter complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>parameterPathInvalid</td> <td>Provided parameter path is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>objectMetadataNotFound</td> <td>Object metadata not found.</td> </tr> </table>

0 - Other error with any status code and response body format.

Parameters:

requestObject - - Object of type RetrieveObjectMetadataRequest {Parameters are path*,subtenantId}

Returns:

ObjectMetaDataResponse

Throws:

MindsphereException - if an error occurs while attempting to invoke the API