org.finra.herd.sdk.api

Class StorageUnitNotificationRegistrationApi

java.lang.Object

org.finra.herd.sdk.api.StorageUnitNotificationRegistrationApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class StorageUnitNotificationRegistrationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
StorageUnitNotificationRegistrationApi()
StorageUnitNotificationRegistrationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
StorageUnitNotificationRegistration	storageUnitNotificationRegistrationCreateStorageUnitNotificationRegistration(StorageUnitNotificationRegistrationCreateRequest storageUnitNotificationRegistrationCreateRequest) createStorageUnitNotificationRegistration Creates a new storage unit notification registration.
StorageUnitNotificationRegistration	storageUnitNotificationRegistrationDeleteStorageUnitNotification(String namespace, String notificationName) deleteStorageUnitNotification Deletes an existing storage unit notification registration by key.
StorageUnitNotificationRegistration	storageUnitNotificationRegistrationGetStorageUnitNotificationRegistration(String namespace, String notificationName) getStorageUnitNotificationRegistration Gets an existing storage unit notification registration by key.
StorageUnitNotificationRegistrationKeys	storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNamespace(String namespace) getStorageUnitNotificationRegistrationsByNamespace Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.
StorageUnitNotificationRegistrationKeys	storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType) getStorageUnitNotificationRegistrationsByNotificationFilter <p> Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.
StorageUnitNotificationRegistration	storageUnitNotificationRegistrationUpdateStorageUnitNotificationRegistration(String namespace, String notificationName, StorageUnitNotificationRegistrationUpdateRequest storageUnitNotificationRegistrationUpdateRequest) updateStorageUnitNotificationRegistration Updates an existing storage unit notification registration by key.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageUnitNotificationRegistrationApi

public StorageUnitNotificationRegistrationApi()

StorageUnitNotificationRegistrationApi

public StorageUnitNotificationRegistrationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNotificationFilter

public StorageUnitNotificationRegistrationKeys storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace,
                                                                                                                                              String businessObjectDefinitionName,
                                                                                                                                              String businessObjectFormatUsage,
                                                                                                                                              String businessObjectFormatFileType)
                                                                                                                                       throws ApiException

getStorageUnitNotificationRegistrationsByNotificationFilter <p> Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters. </p> <p> This endpoint requires both namespace and name of the business object definition. </p> <p>Requires READ permission on business object definition namespace</p>

Parameters:

businessObjectDefinitionNamespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectFormatUsage - the usage of the business object format

businessObjectFormatFileType - the file type of the business object format

Returns:

StorageUnitNotificationRegistrationKeys

Throws:

ApiException

storageUnitNotificationRegistrationCreateStorageUnitNotificationRegistration

public StorageUnitNotificationRegistration storageUnitNotificationRegistrationCreateStorageUnitNotificationRegistration(StorageUnitNotificationRegistrationCreateRequest storageUnitNotificationRegistrationCreateRequest)
                                                                                                                 throws ApiException

createStorageUnitNotificationRegistration Creates a new storage unit notification registration. <p>Requires WRITE permission on namespace</p> <p>Requires READ permission on filter namespace</p> <p>Requires EXECUTE permission on ALL job action namespaces</p>

Parameters:

storageUnitNotificationRegistrationCreateRequest - the information needed to create the storage unit notification registration

Returns:

StorageUnitNotificationRegistration

Throws:

ApiException

storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNamespace

public StorageUnitNotificationRegistrationKeys storageUnitNotificationRegistrationGetStorageUnitNotificationRegistrationsByNamespace(String namespace)
                                                                                                                              throws ApiException

getStorageUnitNotificationRegistrationsByNamespace Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.

Parameters:

namespace - the namespace of the storage unit notification registration

Returns:

StorageUnitNotificationRegistrationKeys

Throws:

ApiException

storageUnitNotificationRegistrationGetStorageUnitNotificationRegistration

public StorageUnitNotificationRegistration storageUnitNotificationRegistrationGetStorageUnitNotificationRegistration(String namespace,
                                                                                                                     String notificationName)
                                                                                                              throws ApiException

getStorageUnitNotificationRegistration Gets an existing storage unit notification registration by key. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

Returns:

StorageUnitNotificationRegistration

Throws:

ApiException

storageUnitNotificationRegistrationUpdateStorageUnitNotificationRegistration

public StorageUnitNotificationRegistration storageUnitNotificationRegistrationUpdateStorageUnitNotificationRegistration(String namespace,
                                                                                                                        String notificationName,
                                                                                                                        StorageUnitNotificationRegistrationUpdateRequest storageUnitNotificationRegistrationUpdateRequest)
                                                                                                                 throws ApiException

updateStorageUnitNotificationRegistration Updates an existing storage unit notification registration by key. <p>Requires WRITE permission on namespace</p> <p>Requires READ permission on filter namespace</p> <p>Requires EXECUTE permission on ALL job action namespaces</p>

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

storageUnitNotificationRegistrationUpdateRequest - the information needed to update the storage unit notification registration

Returns:

StorageUnitNotificationRegistration

Throws:

ApiException

storageUnitNotificationRegistrationDeleteStorageUnitNotification

public StorageUnitNotificationRegistration storageUnitNotificationRegistrationDeleteStorageUnitNotification(String namespace,
                                                                                                            String notificationName)
                                                                                                     throws ApiException

deleteStorageUnitNotification Deletes an existing storage unit notification registration by key. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

Returns:

StorageUnitNotificationRegistration

Throws:

ApiException