org.openapitools.client.api

Class SchemaApi

java.lang.Object

org.openapitools.client.api.SchemaApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
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()
UserSchema	getApplicationUserSchema(String appId) Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User
UserSchema	getApplicationUserSchema(String appId, Map<String,String> additionalHeaders) Retrieve the default Application User Schema for an Application Retrieves the Schema for an App User
ApplicationLayout	getAppUISchema(String appName, String section, String operation) Retrieve the UI schema for a section Retrieves the UI schema for an Application given `appName`, `section` and `operation`
ApplicationLayout	getAppUISchema(String appName, String section, String operation, Map<String,String> additionalHeaders) Retrieve the UI schema for a section Retrieves the UI schema for an Application given `appName`, `section` and `operation`
ApplicationLayouts	getAppUISchemaLinks(String appName) Retrieve the links for UI schemas for an Application Retrieves the links for UI schemas for an Application given `appName`
ApplicationLayouts	getAppUISchemaLinks(String appName, Map<String,String> additionalHeaders) Retrieve the links for UI schemas for an Application Retrieves the links for UI schemas for an Application given `appName`
GroupSchema	getGroupSchema() Retrieve the default Group Schema Retrieves the group schema
GroupSchema	getGroupSchema(Map<String,String> additionalHeaders) 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.
LogStreamSchema	getLogStreamSchema(LogStreamType logStreamType, Map<String,String> additionalHeaders) Retrieve the Log Stream Schema for the schema type Retrieves the schema for a Log Stream type.
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
UserSchema	getUserSchema(String schemaId) Retrieve a User Schema Retrieves the schema for a Schema Id
UserSchema	getUserSchema(String schemaId, Map<String,String> additionalHeaders) 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
List<LogStreamSchema>	listLogStreamSchemas(Map<String,String> additionalHeaders) List the Log Stream Schemas Lists the schema for all log stream types visible for this org
void	setApiClient(ApiClient apiClient)
UserSchema	updateApplicationUserProfile(String appId, UserSchema body) Update the default Application User Schema for an Application Partially updates on the User Profile properties of the Application User Schema
UserSchema	updateApplicationUserProfile(String appId, UserSchema body, Map<String,String> additionalHeaders) Update the default Application User Schema for an Application Partially updates on the User Profile properties of the Application User Schema
GroupSchema	updateGroupSchema(GroupSchema groupSchema) Update the default Group Schema Updates the default group schema.
GroupSchema	updateGroupSchema(GroupSchema groupSchema, Map<String,String> additionalHeaders) Update the default Group Schema Updates the default group schema.
UserSchema	updateUserProfile(String schemaId, UserSchema userSchema) Update a User Schema Partially updates on the User Profile properties of the user schema
UserSchema	updateUserProfile(String schemaId, UserSchema userSchema, Map<String,String> additionalHeaders) Update a User Schema Partially 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

public SchemaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAppUISchema

public ApplicationLayout getAppUISchema(String appName,
                                        String section,
                                        String operation)
                                 throws ApiException

Retrieve the UI schema for a section Retrieves the UI schema for an Application given `appName`, `section` and `operation`

Parameters:

appName - (required)

section - (required)

operation - (required)

Returns:

ApplicationLayout

Throws:

ApiException - if fails to make API call

getAppUISchema

public ApplicationLayout getAppUISchema(String appName,
                                        String section,
                                        String operation,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

Retrieve the UI schema for a section Retrieves the UI schema for an Application given `appName`, `section` and `operation`

Parameters:

appName - (required)

section - (required)

operation - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ApplicationLayout

Throws:

ApiException - if fails to make API call

getAppUISchemaLinks

public ApplicationLayouts getAppUISchemaLinks(String appName)
                                       throws ApiException

Retrieve the links for UI schemas for an Application Retrieves the links for UI schemas for an Application given `appName`

Parameters:

appName - (required)

Returns:

ApplicationLayouts

Throws:

ApiException - if fails to make API call

getAppUISchemaLinks

public ApplicationLayouts getAppUISchemaLinks(String appName,
                                              Map<String,String> additionalHeaders)
                                       throws ApiException

Retrieve the links for UI schemas for an Application Retrieves the links for UI schemas for an Application given `appName`

Parameters:

appName - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ApplicationLayouts

Throws:

ApiException - if fails to make API call

getApplicationUserSchema

public UserSchema getApplicationUserSchema(String appId)
                                    throws ApiException

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

Parameters:

appId - ID of the Application (required)

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

getApplicationUserSchema

public UserSchema getApplicationUserSchema(String appId,
                                           Map<String,String> additionalHeaders)
                                    throws ApiException

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

Parameters:

appId - ID of the Application (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

getGroupSchema

public GroupSchema getGroupSchema()
                           throws ApiException

Retrieve the default Group Schema Retrieves the group schema

Returns:

GroupSchema

Throws:

ApiException - if fails to make API call

getGroupSchema

public GroupSchema getGroupSchema(Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve the default Group Schema Retrieves the group schema

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

GroupSchema

Throws:

ApiException - if fails to make API call

getLogStreamSchema

public LogStreamSchema getLogStreamSchema(LogStreamType logStreamType)
                                   throws ApiException

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.

Parameters:

logStreamType - (required)

Returns:

LogStreamSchema

Throws:

ApiException - if fails to make API call

getLogStreamSchema

public LogStreamSchema getLogStreamSchema(LogStreamType logStreamType,
                                          Map<String,String> additionalHeaders)
                                   throws ApiException

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.

Parameters:

logStreamType - (required)

additionalHeaders - additionalHeaders for this call

Returns:

LogStreamSchema

Throws:

ApiException - if fails to make API call

getUserSchema

public UserSchema getUserSchema(String schemaId)
                         throws ApiException

Retrieve a User Schema Retrieves the schema for a Schema Id

Parameters:

schemaId - (required)

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

getUserSchema

public UserSchema getUserSchema(String schemaId,
                                Map<String,String> additionalHeaders)
                         throws ApiException

Retrieve a User Schema Retrieves the schema for a Schema Id

Parameters:

schemaId - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

listLogStreamSchemas

public List<LogStreamSchema> listLogStreamSchemas()
                                           throws ApiException

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

Returns:

List<LogStreamSchema>

Throws:

ApiException - if fails to make API call

listLogStreamSchemas

public List<LogStreamSchema> listLogStreamSchemas(Map<String,String> additionalHeaders)
                                           throws ApiException

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

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<LogStreamSchema>

Throws:

ApiException - if fails to make API call

updateApplicationUserProfile

public UserSchema updateApplicationUserProfile(String appId,
                                               UserSchema body)
                                        throws ApiException

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

Parameters:

appId - ID of the Application (required)

body - (optional)

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

updateApplicationUserProfile

public UserSchema updateApplicationUserProfile(String appId,
                                               UserSchema body,
                                               Map<String,String> additionalHeaders)
                                        throws ApiException

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

Parameters:

appId - ID of the Application (required)

body - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

updateGroupSchema

public GroupSchema updateGroupSchema(GroupSchema groupSchema)
                              throws ApiException

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

Parameters:

groupSchema - (optional)

Returns:

GroupSchema

Throws:

ApiException - if fails to make API call

updateGroupSchema

public GroupSchema updateGroupSchema(GroupSchema groupSchema,
                                     Map<String,String> additionalHeaders)
                              throws ApiException

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

Parameters:

groupSchema - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GroupSchema

Throws:

ApiException - if fails to make API call

updateUserProfile

public UserSchema updateUserProfile(String schemaId,
                                    UserSchema userSchema)
                             throws ApiException

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

Parameters:

schemaId - (required)

userSchema - (required)

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

updateUserProfile

public UserSchema updateUserProfile(String schemaId,
                                    UserSchema userSchema,
                                    Map<String,String> additionalHeaders)
                             throws ApiException

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

Parameters:

schemaId - (required)

userSchema - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserSchema

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()