Package com.influxdb.client.service

Interface OrganizationsService

public interface OrganizationsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteOrgsID(String orgID, String zapTraceSpan)	Delete an organization
retrofit2.Call<Void>	deleteOrgsIDMembersID(String userID, String orgID, String zapTraceSpan)	Remove a member from an organization
retrofit2.Call<Void>	deleteOrgsIDOwnersID(String userID, String orgID, String zapTraceSpan)	Remove an owner from an organization
retrofit2.Call<Organizations>	getOrgs(String zapTraceSpan, Integer offset, Integer limit, Boolean descending, String org, String orgID, String userID)	List all organizations
retrofit2.Call<Organization>	getOrgsID(String orgID, String zapTraceSpan)	Retrieve an organization
retrofit2.Call<ResourceMembers>	getOrgsIDMembers(String orgID, String zapTraceSpan)	List all members of an organization
retrofit2.Call<ResourceOwners>	getOrgsIDOwners(String orgID, String zapTraceSpan)	List all owners of an organization
retrofit2.Call<Organization>	patchOrgsID(String orgID, PatchOrganizationRequest patchOrganizationRequest, String zapTraceSpan)	Update an organization
retrofit2.Call<Organization>	postOrgs(PostOrganizationRequest postOrganizationRequest, String zapTraceSpan)	Create an organization
retrofit2.Call<ResourceMember>	postOrgsIDMembers(String orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add a member to an organization
retrofit2.Call<ResourceOwner>	postOrgsIDOwners(String orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add an owner to an organization

Method Details

deleteOrgsID

@DELETE("api/v2/orgs/{orgID}")
retrofit2.Call<Void> deleteOrgsID(@Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete an organization

Parameters:

orgID - The ID of the organization to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteOrgsIDMembersID

@DELETE("api/v2/orgs/{orgID}/members/{userID}")
retrofit2.Call<Void> deleteOrgsIDMembersID(@Path("userID")
 String userID,
 @Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove a member from an organization

Parameters:

userID - The ID of the member to remove. (required)

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteOrgsIDOwnersID

@DELETE("api/v2/orgs/{orgID}/owners/{userID}")
retrofit2.Call<Void> deleteOrgsIDOwnersID(@Path("userID")
 String userID,
 @Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove an owner from an organization

Parameters:

userID - The ID of the owner to remove. (required)

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getOrgs

@GET("api/v2/orgs")
retrofit2.Call<Organizations> getOrgs(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("descending")
 Boolean descending,
 @Query("org")
 String org,
 @Query("orgID")
 String orgID,
 @Query("userID")
 String userID)

List all organizations

Parameters:

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

descending - (optional, default to false)

org - Filter organizations to a specific organization name. (optional)

orgID - Filter organizations to a specific organization ID. (optional)

userID - Filter organizations to a specific user ID. (optional)

Returns:

Call<Organizations>

getOrgsID

@GET("api/v2/orgs/{orgID}")
retrofit2.Call<Organization> getOrgsID(@Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve an organization

Parameters:

orgID - The ID of the organization to get. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Organization>

getOrgsIDMembers

@GET("api/v2/orgs/{orgID}/members")
retrofit2.Call<ResourceMembers> getOrgsIDMembers(@Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all members of an organization

Parameters:

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMembers>

getOrgsIDOwners

@GET("api/v2/orgs/{orgID}/owners")
retrofit2.Call<ResourceOwners> getOrgsIDOwners(@Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all owners of an organization

Parameters:

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwners>

patchOrgsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/orgs/{orgID}")
retrofit2.Call<Organization> patchOrgsID(@Path("orgID")
 String orgID,
 @Body
 PatchOrganizationRequest patchOrganizationRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update an organization

Parameters:

orgID - The ID of the organization to get. (required)

patchOrganizationRequest - Organization update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Organization>

postOrgs

@Headers("Content-Type:application/json")
@POST("api/v2/orgs")
retrofit2.Call<Organization> postOrgs(@Body
 PostOrganizationRequest postOrganizationRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create an organization

Parameters:

postOrganizationRequest - Organization to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Organization>

postOrgsIDMembers

@Headers("Content-Type:application/json")
@POST("api/v2/orgs/{orgID}/members")
retrofit2.Call<ResourceMember> postOrgsIDMembers(@Path("orgID")
 String orgID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a member to an organization

Parameters:

orgID - The organization ID. (required)

addResourceMemberRequestBody - User to add as member (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMember>

postOrgsIDOwners

@Headers("Content-Type:application/json")
@POST("api/v2/orgs/{orgID}/owners")
retrofit2.Call<ResourceOwner> postOrgsIDOwners(@Path("orgID")
 String orgID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add an owner to an organization

Parameters:

orgID - The organization ID. (required)

addResourceMemberRequestBody - User to add as owner (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwner>