com.siemens.mindsphere.sdk.assetmanagement.apiclient

Class AspecttypeClient

Object

MindsphereAPIClient

AspecttypeClient

public class AspecttypeClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AspecttypeClient.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
AspecttypeClient(AspecttypeClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static AspecttypeClient.ClientBuilder	builder()
void	deleteAspectType(DeleteAspectTypeRequest requestObject) Delete aspect type Delete an aspect type.
void	deleteAspectType(String ifMatch, String id) Delete aspect type Delete an aspect type.
AspectTypeResource	getAspectType(GetAspectTypeRequest requestObject) Read an aspect type Read an aspect type.
AspectTypeResource	getAspectType(String id, String ifNoneMatch) Read an aspect type Read an aspect type.
AspectTypeListResource	getAspectTypesContains(FieldTypeEnum fieldType, String filterValue) Filter aspect types by name or tenantId.
AspectTypeListResource	getAspectTypesEndsWith(FieldTypeEnum fieldType, String filterValue) Filter aspect types by name or tenantId.
AspectTypeListResource	getAspectTypesEqualTo(FieldTypeEnum fieldType, String filterValue) Filter aspect types by name or tenantId.
AspectTypeListResource	getAspectTypesLike(FieldTypeEnum fieldType, String... filterValue) Filter aspect types by name or tenantId.
AspectTypeListResource	getAspectTypesStartsWith(FieldTypeEnum fieldType, String filterValue) Filter aspect types by name or tenantId.
AspectTypeListResource	listAspectTypes(Integer page, Integer size, String sort, String filter, String ifNoneMatch) List all aspect types List all aspect types
AspectTypeListResource	listAspectTypes(ListAspectTypesRequest requestObject) List all aspect types List all aspect types
AspectTypeResource	saveAspectType(SaveAspectTypeRequest requestObject) Create or Update an aspect type Create or Update an aspect type.
AspectTypeResource	saveAspectType(String id, AspectType aspecttype, String ifMatch) Create or Update an aspect type Create or Update an aspect type.
AspectTypeResource	saveAspectType(String id, AspectType aspecttype, String ifMatch, String ifNoneMatch) Create or Update an aspect type Create or Update an aspect type.
AspectTypeResource	updateAspectType(String ifMatch, String id, AspectType aspecttype) Patch an aspect type Patch an aspect type.
AspectTypeResource	updateAspectType(UpdateAspectTypeRequest requestObject) Patch an aspect type Patch an aspect type.

Methods inherited from class Object

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

Constructor Detail

AspecttypeClient

public AspecttypeClient(AspecttypeClient.ClientBuilder builder)

Method Detail

builder

public static AspecttypeClient.ClientBuilder builder()

deleteAspectType

public void deleteAspectType(DeleteAspectTypeRequest requestObject)
                      throws MindsphereException

Delete aspect type Delete an aspect type. Aspect type can only be deleted if there is no asset type using it.

204 - Aspect type deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

requestObject - - Object of type DeleteAspectTypeRequest {Parameters are If-Match*,id*}

Throws:

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

getAspectType

public AspectTypeResource getAspectType(GetAspectTypeRequest requestObject)
                                 throws MindsphereException

Read an aspect type Read an aspect type.

200 - Returns the aspect type

304 - AspectType not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

500 - Server error, for more information see errorcode and message

Parameters:

requestObject - - Object of type GetAspectTypeRequest {Parameters are id*,If-None-Match}

Returns:

AspectTypeResource

Throws:

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

listAspectTypes

public AspectTypeListResource listAspectTypes(ListAspectTypesRequest requestObject)
                                       throws MindsphereException

List all aspect types List all aspect types

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

requestObject - - Object of type ListAspectTypesRequest {Parameters are page,size,sort,filter,If-None-Match}

Returns:

AspectTypeListResource

Throws:

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

saveAspectType

public AspectTypeResource saveAspectType(SaveAspectTypeRequest requestObject)
                                  throws MindsphereException

Create or Update an aspect type Create or Update an aspect type. Only adding variables supported.

200 - The aspect type has been updated

201 - The aspect type has been created

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

requestObject - - Object of type SaveAspectTypeRequest {Parameters are id*,aspecttype*,If-Match,If-None-Match}

Returns:

AspectTypeResource

Throws:

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

updateAspectType

public AspectTypeResource updateAspectType(UpdateAspectTypeRequest requestObject)
                                    throws MindsphereException

Patch an aspect type Patch an aspect type. Only adding variables supported. Patching requires the inclusion of already existing variables. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.

200 - The aspect type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

requestObject - - Object of type UpdateAspectTypeRequest {Parameters are If-Match*,id*,aspecttype*}

Returns:

AspectTypeResource

Throws:

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

deleteAspectType

public void deleteAspectType(String ifMatch,
                             String id)
                      throws MindsphereException

Delete aspect type Delete an aspect type. Aspect type can only be deleted if there is no asset type using it.

204 - Aspect type deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

Throws:

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

getAspectType

public AspectTypeResource getAspectType(String id,
                                        String ifNoneMatch)
                                 throws MindsphereException

Read an aspect type Read an aspect type.

200 - Returns the aspect type

304 - AspectType not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

500 - Server error, for more information see errorcode and message

Parameters:

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AspectTypeResource

Throws:

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

listAspectTypes

public AspectTypeListResource listAspectTypes(Integer page,
                                              Integer size,
                                              String sort,
                                              String filter,
                                              String ifNoneMatch)
                                       throws MindsphereException

List all aspect types List all aspect types

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

page - Specifies the requested page index

size - Specifies the number of elements in a page

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AspectTypeListResource

Throws:

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

saveAspectType

public AspectTypeResource saveAspectType(String id,
                                         AspectType aspecttype,
                                         String ifMatch)
                                  throws MindsphereException

Create or Update an aspect type Create or Update an aspect type. Only adding variables supported.

200 - The aspect type has been updated

201 - The aspect type has been created

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

aspecttype - aspect type

ifMatch - Last known version to facilitate optimistic locking

Returns:

AspectTypeResource

Throws:

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

saveAspectType

public AspectTypeResource saveAspectType(String id,
                                         AspectType aspecttype,
                                         String ifMatch,
                                         String ifNoneMatch)
                                  throws MindsphereException

Create or Update an aspect type Create or Update an aspect type. Only adding variables supported.

200 - The aspect type has been updated

201 - The aspect type has been created

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

aspecttype - aspect type

ifMatch - Last known version to facilitate optimistic locking

ifNoneMatch - Set ifNoneMatch header to \"*\" for ensuring create request

Returns:

AspectTypeResource

Throws:

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

updateAspectType

public AspectTypeResource updateAspectType(String ifMatch,
                                           String id,
                                           AspectType aspecttype)
                                    throws MindsphereException

Patch an aspect type Patch an aspect type. Only adding variables supported. Patching requires the inclusion of already existing variables. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.

200 - The aspect type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

500 - Server error, for more information see errorcode and message

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

aspecttype - aspect type

Returns:

AspectTypeResource

Throws:

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

getAspectTypesEqualTo

public AspectTypeListResource getAspectTypesEqualTo(FieldTypeEnum fieldType,
                                                    String filterValue)
                                             throws MindsphereException

Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId equals to filterValue. Only one field type and value can be passed at a time.

200 - Array of aspect types matched the tenant scope and filtered Aspects types with provided values

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

fieldType - Field type on which aspect types need to be filtered.

filterValue - Value based on which aspect types need to be filtered.

Returns:

AspectTypeListResource

Throws:

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

getAspectTypesLike

public AspectTypeListResource getAspectTypesLike(FieldTypeEnum fieldType,
                                                 String... filterValue)
                                          throws MindsphereException

Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId matches an array of filter values. One field type and multiple filter values can be passed.

200 - Array of aspect types matched the tenant scope and filtered Aspects types with array of provided values

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

fieldType - Field type on which aspect types need to be filtered.

filterValue - Variable array of values based on which aspect types need to be filtered.

Returns:

AspectTypeListResource

Throws:

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

getAspectTypesStartsWith

public AspectTypeListResource getAspectTypesStartsWith(FieldTypeEnum fieldType,
                                                       String filterValue)
                                                throws MindsphereException

Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId starts with the filter value. Only one field type and filter value can be passed.

200 - Array of aspect types matched the tenant scope and filtered Aspect types who name start with input values

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

fieldType - Field type on which aspect types need to be filtered.

filterValue - Value based on which aspect types need to be filtered.

Returns:

AspectTypeListResource

Throws:

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

getAspectTypesEndsWith

public AspectTypeListResource getAspectTypesEndsWith(FieldTypeEnum fieldType,
                                                     String filterValue)
                                              throws MindsphereException

Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId ends with the filter value. Only one field type and filter value can be passed.

200 - Array of aspect types matched the tenant scope and filtered Aspect types who name end with input values

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

fieldType - Field type on which aspect types need to be filtered.

filterValue - Value based on which aspect types need to be filtered.

Returns:

AspectTypeListResource

Throws:

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

getAspectTypesContains

public AspectTypeListResource getAspectTypesContains(FieldTypeEnum fieldType,
                                                     String filterValue)
                                              throws MindsphereException

Filter aspect types by name or tenantId. Returns aspect types whose name or tenantId contains the filter value. Only one field type and filter value can be passed.

200 - Array of aspect types matched the tenant scope and filtered Aspect types who name start with contains values

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

fieldType - Field type on which aspect types need to be filtered.

filterValue - Value based on which aspect types need to be filtered.

Returns:

AspectTypeListResource

Throws:

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