Image Members
1. set_image(image_id)
Before using members, you should set image with image id
Parameters:
| Name | Type | Desription |
|---|---|---|
| image_id | string | set the default id of image to be use |
Return value: None
2. get_member(member)
Get a member
Parameters:
| Name | Type | Description |
|---|---|---|
| member | string | the id of a member |
Return value: Member Instance
Return value example:
istack/image/v2/member Member
status : pending
image_id : b4e7edae-0ae6-41d7-b03f-05349d081033
member_id : 8989447062e04a818baf9e073fd04fa7
created_at : 2016-08-18T09:02:16Z
updated_at : 2016-08-26T08:39:36Z
schema : /v2/schemas/member
3. members()
List the members
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | if you specify this parameter, you will get exactly one member instance |
Return value: Member Object
Return value example:
istack/image/v2/member Member
status : pending
image_id : b4e7edae-0ae6-41d7-b03f-05349d081033
member_id : 8989447062e04a818baf9e073fd04fa7
created_at : 2016-08-18T09:02:16Z
updated_at : 2016-08-26T08:39:36Z
schema : /v2/schemas/member
4. create_member(**attrs)
Create a member.
Parameters: member object
| Name | Type | Description |
|---|---|---|
| member_id | string(inside member param) | ID of an image member |
| status | string | pending, accepted, rejected. Three of above. |
Return value: Member Object
Return value example:
istack/image/v2/member Member
status : pending
image_id : b4e7edae-0ae6-41d7-b03f-05349d081033
member_id : 8989447062e04a818baf9e073fd04fa7
created_at : 2016-08-18T09:02:16Z
updated_at : 2016-08-26T08:39:36Z
schema : /v2/schemas/member
5. update_member(member, **attrs)
Update a member.
Parameters: member object
| Name | Type | Description |
|---|---|---|
| member_id | string(inside member param) | ID of an image member |
| status | string | pending, accepted, rejected. Three of above. |
Parameter example:
# first set the image
cloud.image.set_image(image_id)
member = cloud.image.update_member(member, status="accepted")
# then we can perform the delete Syntax
Return value: Member Object
Return value example:
istack/image/v2/member Member
status : pending
image_id : b4e7edae-0ae6-41d7-b03f-05349d081033
member_id : 8989447062e04a818baf9e073fd04fa7
created_at : 2016-08-18T09:02:16Z
updated_at : 2016-08-26T08:39:36Z
schema : /v2/schemas/member
6. delete_member(member)
Delete a member
Parameters: member object
| Name | Type | Description |
|---|---|---|
| id | string(inside member param) | to delete a member, at least id is specified inside a member object |
Parameter example:
# deprecated, a member instance is recommended to get from the other methods
# but not build yourself
member = Member()
member[‘id’] = ‘78dsa94da654d86ad4a6d4’
cloud.image.delete_member(member)
Return value: None