content/api-docs/master/workspace_model.html [1:111]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Thrift module: workspace_model

Thrift module: workspace_model

Module	Services	Data types	Constants
workspace_model		Gateway GatewayApprovalStatus GatewayUsageReportingCommand Group Notification NotificationPriority Project User

Enumerations

Enumeration: GatewayApprovalStatus

`REQUESTED`	`0`
`APPROVED`	`1`
`ACTIVE`	`2`
`DEACTIVATED`	`3`
`CANCELLED`	`4`
`DENIED`	`5`
`CREATED`	`6`
`DEPLOYED`	`7`

Enumeration: NotificationPriority

`LOW`	`0`
`NORMAL`	`1`
`HIGH`	`2`

Data structures

Struct: Group

Key	Field	Type	Description	Requiredness	Default value
1	groupName	`string`		required
2	description	`string`		optional

Struct: Project

Key	Field	Type	Description	Requiredness	Default value
1	projectID	`string`		required	`"DO_NOT_SET_AT_CLIENTS"`
2	owner	`string`		required
3	gatewayId	`string`		required
4	name	`string`		required
5	description	`string`		optional
6	creationTime	`i64`		optional
7	sharedUsers	`list<string>`		optional
8	sharedGroups	`list<string>`		optional

Struct: User

Key	Field	Type	Description	Requiredness	Default value
1	airavataInternalUserId	`string`		required	`"DO_NOT_SET_AT_CLIENTS"`
2	userName	`string`		optional
3	gatewayId	`string`		required
4	firstName	`string`		optional
5	lastName	`string`		optional
6	email	`string`		optional

Struct: Gateway

Key	Field	Type	Description	Requiredness	Default value
1	airavataInternalGatewayId	`string`		optional
2	gatewayId	`string`		required
3	gatewayApprovalStatus	`GatewayApprovalStatus`		required
4	gatewayName	`string`		optional
5	domain	`string`		optional
6	emailAddress	`string`		optional
7	gatewayAcronym	`string`		optional
8	gatewayURL	`string`		optional
9	gatewayPublicAbstract	`string`		optional
10	reviewProposalDescription	`string`		optional
11	gatewayAdminFirstName	`string`		optional
12	gatewayAdminLastName	`string`		optional
13	gatewayAdminEmail	`string`		optional
14	identityServerUserName	`string`		optional
15	identityServerPasswordToken	`string`		optional
16	declinedReason	`string`		optional
17	oauthClientId	`string`		optional
18	oauthClientSecret	`string`		optional
19	requestCreationTime	`i64`		optional
20	requesterUsername	`string`		optional

Struct: GatewayUsageReportingCommand

Key	Field	Type	Description	Requiredness	Default value
1	gatewayId	`string`		required
2	computeResourceId	`string`		required
3	command	`string`		required

Struct: Notification

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - source/api-docs/master/workspace_model.html [1:111]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Thrift module: workspace_model

Thrift module: workspace_model

Key	Field	Type	Description	Requiredness	Default value
1	notificationId	`string`		optional
2	gatewayId	`string`		required
3	title	`string`		required
4	notificationMessage	`string`		required
5	creationTime	`i64`		optional
6	publishedTime	`i64`		optional
7	expirationTime	`i64`		optional
8	priority	`NotificationPriority`		optional

Module	Services	Data types	Constants
workspace_model		Gateway GatewayApprovalStatus GatewayUsageReportingCommand Group Notification NotificationPriority Project User

Enumerations

Enumeration: GatewayApprovalStatus

`REQUESTED`	`0`
`APPROVED`	`1`
`ACTIVE`	`2`
`DEACTIVATED`	`3`
`CANCELLED`	`4`
`DENIED`	`5`
`CREATED`	`6`
`DEPLOYED`	`7`

Enumeration: NotificationPriority

`LOW`	`0`
`NORMAL`	`1`
`HIGH`	`2`

Data structures

Struct: Group

Key	Field	Type	Description	Requiredness	Default value
1	groupName	`string`		required
2	description	`string`		optional

Struct: Project

Key	Field	Type	Description	Requiredness	Default value
1	projectID	`string`		required	`"DO_NOT_SET_AT_CLIENTS"`
2	owner	`string`		required
3	gatewayId	`string`		required
4	name	`string`		required
5	description	`string`		optional
6	creationTime	`i64`		optional
7	sharedUsers	`list<string>`		optional
8	sharedGroups	`list<string>`		optional

Struct: User

Key	Field	Type	Description	Requiredness	Default value
1	airavataInternalUserId	`string`		required	`"DO_NOT_SET_AT_CLIENTS"`
2	userName	`string`		optional
3	gatewayId	`string`		required
4	firstName	`string`		optional
5	lastName	`string`		optional
6	email	`string`		optional

Struct: Gateway

Key	Field	Type	Description	Requiredness	Default value
1	airavataInternalGatewayId	`string`		optional
2	gatewayId	`string`		required
3	gatewayApprovalStatus	`GatewayApprovalStatus`		required
4	gatewayName	`string`		optional
5	domain	`string`		optional
6	emailAddress	`string`		optional
7	gatewayAcronym	`string`		optional
8	gatewayURL	`string`		optional
9	gatewayPublicAbstract	`string`		optional
10	reviewProposalDescription	`string`		optional
11	gatewayAdminFirstName	`string`		optional
12	gatewayAdminLastName	`string`		optional
13	gatewayAdminEmail	`string`		optional
14	identityServerUserName	`string`		optional
15	identityServerPasswordToken	`string`		optional
16	declinedReason	`string`		optional
17	oauthClientId	`string`		optional
18	oauthClientSecret	`string`		optional
19	requestCreationTime	`i64`		optional
20	requesterUsername	`string`		optional

Struct: GatewayUsageReportingCommand

Key	Field	Type	Description	Requiredness	Default value
1	gatewayId	`string`		required
2	computeResourceId	`string`		required
3	command	`string`		required

Struct: Notification

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Key	Field	Type	Description	Requiredness	Default value
1	notificationId	`string`		optional
2	gatewayId	`string`		required
3	title	`string`		required
4	notificationMessage	`string`		required
5	creationTime	`i64`		optional
6	publishedTime	`i64`		optional
7	expirationTime	`i64`		optional
8	priority	`NotificationPriority`		optional