org.openapitools.client.api

Class SchemaApi

java.lang.Object

org.openapitools.client.api.SchemaApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-10T11:07:35.698-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.SchemaApi")
public class SchemaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SchemaApi()
SchemaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ApplicationLayout	getApplicationLayout(String appName) Retrieve the UI Layout for an Application Takes an Application name as an input parameter and retrieves the App Instance page Layout for that Application
PagedList	getApplicationLayoutWithPaginationInfo(String appName) Retrieve the UI Layout for an Application Takes an Application name as an input parameter and retrieves the App Instance page Layout for that Application
UserSchema	getApplicationUserSchema(String appInstanceId) Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User
PagedList	getApplicationUserSchemaWithPaginationInfo(String appInstanceId) Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User
GroupSchema	getGroupSchema() Retrieve the default Group Schema Retrieves the group schema
PagedList	getGroupSchemaWithPaginationInfo() Retrieve the default Group Schema Retrieves the group schema
LogStreamSchema	getLogStreamSchema(LogStreamType logStreamType) Retrieve the Log Stream Schema for the schema type Retrieves the schema for a Log Stream type.
PagedList	getLogStreamSchemaWithPaginationInfo(LogStreamType logStreamType) Retrieve the Log Stream Schema for the schema type Retrieves the schema for a Log Stream type.
UserSchema	getUserSchema(String schemaId) Retrieve a User Schema Retrieves the schema for a Schema Id
PagedList	getUserSchemaWithPaginationInfo(String schemaId) Retrieve a User Schema Retrieves the schema for a Schema Id
List<LogStreamSchema>	listLogStreamSchemas() List the Log Stream Schemas Lists the schema for all log stream types visible for this org
PagedList	listLogStreamSchemasWithPaginationInfo() List the Log Stream Schemas Lists the schema for all log stream types visible for this org
void	setApiClient(ApiClient apiClient)
<T> T	updateApplicationUserProfile(Class<?> T, String appInstanceId, UserSchema body) Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema
UserSchema	updateApplicationUserProfile(String appInstanceId, UserSchema body) Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema
PagedList	updateApplicationUserProfileWithPaginationInfo(String appInstanceId, UserSchema body) Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema
<T> T	updateGroupSchema(Class<?> T, GroupSchema groupSchema) Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema
GroupSchema	updateGroupSchema(GroupSchema groupSchema) Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema
PagedList	updateGroupSchemaWithPaginationInfo(GroupSchema groupSchema) Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema
<T> T	updateUserProfile(Class<?> T, String schemaId, UserSchema userSchema) Update a User Schema Partial updates on the User Profile properties of the user schema
UserSchema	updateUserProfile(String schemaId, UserSchema userSchema) Update a User Schema Partial updates on the User Profile properties of the user schema
PagedList	updateUserProfileWithPaginationInfo(String schemaId, UserSchema userSchema) Update a User Schema Partial updates on the User Profile properties of the user schema

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaApi

public SchemaApi()

SchemaApi

@Autowired
public SchemaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getApplicationLayout

public ApplicationLayout getApplicationLayout(String appName)
                                       throws org.springframework.web.client.RestClientException

Retrieve the UI Layout for an Application Takes an Application name as an input parameter and retrieves the App Instance page Layout for that Application

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appName - (required)

Returns:

ApplicationLayout

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getApplicationLayoutWithPaginationInfo

public PagedList getApplicationLayoutWithPaginationInfo(String appName)
                                                 throws org.springframework.web.client.RestClientException

Retrieve the UI Layout for an Application Takes an Application name as an input parameter and retrieves the App Instance page Layout for that Application

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appName - (required)

Returns:

ResponseEntity<ApplicationLayout>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getApplicationUserSchema

public UserSchema getApplicationUserSchema(String appInstanceId)
                                    throws org.springframework.web.client.RestClientException

Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appInstanceId - (required)

Returns:

UserSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getApplicationUserSchemaWithPaginationInfo

public PagedList getApplicationUserSchemaWithPaginationInfo(String appInstanceId)
                                                     throws org.springframework.web.client.RestClientException

Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appInstanceId - (required)

Returns:

ResponseEntity<UserSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupSchema

public GroupSchema getGroupSchema()
                           throws org.springframework.web.client.RestClientException

Retrieve the default Group Schema Retrieves the group schema

200 - successful operation

403 - Forbidden

429 - Too Many Requests

Returns:

GroupSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupSchemaWithPaginationInfo

public PagedList getGroupSchemaWithPaginationInfo()
                                           throws org.springframework.web.client.RestClientException

Retrieve the default Group Schema Retrieves the group schema

200 - successful operation

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<GroupSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLogStreamSchema

public LogStreamSchema getLogStreamSchema(LogStreamType logStreamType)
                                   throws org.springframework.web.client.RestClientException

Retrieve the Log Stream Schema for the schema type Retrieves the schema for a Log Stream type. The `logStreamType` element in the URL specifies the Log Stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamType - (required)

Returns:

LogStreamSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLogStreamSchemaWithPaginationInfo

public PagedList getLogStreamSchemaWithPaginationInfo(LogStreamType logStreamType)
                                               throws org.springframework.web.client.RestClientException

Retrieve the Log Stream Schema for the schema type Retrieves the schema for a Log Stream type. The `logStreamType` element in the URL specifies the Log Stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.

200 - successful operation

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamType - (required)

Returns:

ResponseEntity<LogStreamSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserSchema

public UserSchema getUserSchema(String schemaId)
                         throws org.springframework.web.client.RestClientException

Retrieve a User Schema Retrieves the schema for a Schema Id

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

schemaId - (required)

Returns:

UserSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserSchemaWithPaginationInfo

public PagedList getUserSchemaWithPaginationInfo(String schemaId)
                                          throws org.springframework.web.client.RestClientException

Retrieve a User Schema Retrieves the schema for a Schema Id

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

schemaId - (required)

Returns:

ResponseEntity<UserSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLogStreamSchemas

public List<LogStreamSchema> listLogStreamSchemas()
                                           throws org.springframework.web.client.RestClientException

List the Log Stream Schemas Lists the schema for all log stream types visible for this org

200 - successful operation

403 - Forbidden

429 - Too Many Requests

Returns:

List<LogStreamSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLogStreamSchemasWithPaginationInfo

public PagedList listLogStreamSchemasWithPaginationInfo()
                                                 throws org.springframework.web.client.RestClientException

List the Log Stream Schemas Lists the schema for all log stream types visible for this org

200 - successful operation

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<List<LogStreamSchema>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateApplicationUserProfile

public UserSchema updateApplicationUserProfile(String appInstanceId,
                                               UserSchema body)
                                        throws org.springframework.web.client.RestClientException

Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema

200 - successful operation

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appInstanceId - (required)

body - (optional)

Returns:

UserSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateApplicationUserProfile

public <T> T updateApplicationUserProfile(Class<?> T,
                                          String appInstanceId,
                                          UserSchema body)
                                   throws org.springframework.web.client.RestClientException

Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema

200 - successful operation

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

appInstanceId - (required)

body - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateApplicationUserProfileWithPaginationInfo

public PagedList updateApplicationUserProfileWithPaginationInfo(String appInstanceId,
                                                                UserSchema body)
                                                         throws org.springframework.web.client.RestClientException

Update the default Application User Schema for an Application Partial updates on the User Profile properties of the Application User Schema

200 - successful operation

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

appInstanceId - (required)

body - (optional)

Returns:

ResponseEntity<UserSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateGroupSchema

public GroupSchema updateGroupSchema(GroupSchema groupSchema)
                              throws org.springframework.web.client.RestClientException

Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema

200 - successful operation

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

groupSchema - (optional)

Returns:

GroupSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateGroupSchema

public <T> T updateGroupSchema(Class<?> T,
                               GroupSchema groupSchema)
                        throws org.springframework.web.client.RestClientException

Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema

200 - successful operation

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

groupSchema - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateGroupSchemaWithPaginationInfo

public PagedList updateGroupSchemaWithPaginationInfo(GroupSchema groupSchema)
                                              throws org.springframework.web.client.RestClientException

Update the default Group Schema Updates, adds or removes one or more custom Group Profile properties in the schema

200 - successful operation

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

groupSchema - (optional)

Returns:

ResponseEntity<GroupSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUserProfile

public UserSchema updateUserProfile(String schemaId,
                                    UserSchema userSchema)
                             throws org.springframework.web.client.RestClientException

Update a User Schema Partial updates on the User Profile properties of the user schema

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

schemaId - (required)

userSchema - (required)

Returns:

UserSchema

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUserProfile

public <T> T updateUserProfile(Class<?> T,
                               String schemaId,
                               UserSchema userSchema)
                        throws org.springframework.web.client.RestClientException

Update a User Schema Partial updates on the User Profile properties of the user schema

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

schemaId - (required)

userSchema - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUserProfileWithPaginationInfo

public PagedList updateUserProfileWithPaginationInfo(String schemaId,
                                                     UserSchema userSchema)
                                              throws org.springframework.web.client.RestClientException

Update a User Schema Partial updates on the User Profile properties of the user schema

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

schemaId - (required)

userSchema - (required)

Returns:

ResponseEntity<UserSchema>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API