org.finra.herd.sdk.api

Class PartitionKeyGroupApi

java.lang.Object

org.finra.herd.sdk.api.PartitionKeyGroupApi

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

Constructor Summary

Constructors

Constructor and Description
PartitionKeyGroupApi()
PartitionKeyGroupApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
PartitionKeyGroup	partitionKeyGroupCreatePartitionKeyGroup(PartitionKeyGroupCreateRequest partitionKeyGroupCreateRequest) createPartitionKeyGroup Creates a new partition key group.
PartitionKeyGroup	partitionKeyGroupDeletePartitionKeyGroup(String partitionKeyGroupName) deletePartitionKeyGroup Deletes an existing partition key group by name.
PartitionKeyGroup	partitionKeyGroupGetPartitionKeyGroup(String partitionKeyGroupName) getPartitionKeyGroup Gets an existing partition key group by name.
PartitionKeyGroupKeys	partitionKeyGroupGetPartitionKeyGroups() getPartitionKeyGroups Gets a list of all existing partition key groups.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionKeyGroupApi

public PartitionKeyGroupApi()

PartitionKeyGroupApi

public PartitionKeyGroupApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

partitionKeyGroupGetPartitionKeyGroups

public PartitionKeyGroupKeys partitionKeyGroupGetPartitionKeyGroups()
                                                             throws ApiException

getPartitionKeyGroups Gets a list of all existing partition key groups.

Returns:

PartitionKeyGroupKeys

Throws:

ApiException

partitionKeyGroupCreatePartitionKeyGroup

public PartitionKeyGroup partitionKeyGroupCreatePartitionKeyGroup(PartitionKeyGroupCreateRequest partitionKeyGroupCreateRequest)
                                                           throws ApiException

createPartitionKeyGroup Creates a new partition key group.

Parameters:

partitionKeyGroupCreateRequest - the information needed to create a partition key group

Returns:

PartitionKeyGroup

Throws:

ApiException

partitionKeyGroupGetPartitionKeyGroup

public PartitionKeyGroup partitionKeyGroupGetPartitionKeyGroup(String partitionKeyGroupName)
                                                        throws ApiException

getPartitionKeyGroup Gets an existing partition key group by name.

Parameters:

partitionKeyGroupName - the partition key group name

Returns:

PartitionKeyGroup

Throws:

ApiException

partitionKeyGroupDeletePartitionKeyGroup

public PartitionKeyGroup partitionKeyGroupDeletePartitionKeyGroup(String partitionKeyGroupName)
                                                           throws ApiException

deletePartitionKeyGroup Deletes an existing partition key group by name.

Parameters:

partitionKeyGroupName - the partition key group name

Returns:

PartitionKeyGroup

Throws:

ApiException