Package com.influxdb.client

Interface OrganizationsApi

@ThreadSafe public interface OrganizationsApi
The client of the InfluxDB 2.x that implement Organization HTTP API endpoint.
Author:
Jakub Bednar (bednar@github) (11/09/2018 14:58)

  • Method Details

    • createOrganization

      @Nonnull Organization createOrganization(@Nonnull Organization organization)
      Creates a new organization and sets Organization.getId() with the new identifier.
      Parameters:
      organization - the organization to create
      Returns:
      Organization created

    • createOrganization

      @Nonnull Organization createOrganization(@Nonnull String name)
      Creates a new organization and sets Organization.getId() with the new identifier.
      Parameters:
      name - name of the organization
      Returns:
      Organization created

    • updateOrganization

      @Nonnull Organization updateOrganization(@Nonnull Organization organization)
      Update an organization.
      Parameters:
      organization - organization update to apply
      Returns:
      organization updated

    • deleteOrganization

      void deleteOrganization(@Nonnull Organization organization)
      Delete an organization.
      Parameters:
      organization - organization to delete

    • deleteOrganization

      void deleteOrganization(@Nonnull String orgID)
      Delete an organization.
      Parameters:
      orgID - ID of organization to delete

    • cloneOrganization

      @Nonnull Organization cloneOrganization(@Nonnull String clonedName, @Nonnull String orgID)
      Clone an organization.
      Parameters:
      clonedName - name of cloned organization
      orgID - ID of organization to clone
      Returns:
      cloned organization

    • cloneOrganization

      @Nonnull Organization cloneOrganization(@Nonnull String clonedName, @Nonnull Organization organization)
      Clone an organization.
      Parameters:
      clonedName - name of cloned organization
      organization - organization to clone
      Returns:
      cloned organization

    • findOrganizationByID

      @Nonnull Organization findOrganizationByID(@Nonnull String orgID)
      Retrieve an organization.
      Parameters:
      orgID - ID of organization to get
      Returns:
      organization details

    • findOrganizations

      @Nonnull List<Organization> findOrganizations()
      List all organizations.
      Returns:
      List all organizations

    • findOrganizations

      @Nonnull List<Organization> findOrganizations(@Nonnull OrganizationsQuery query)
      List all organizations.
      Returns:
      List all organizations

    • getSecrets

      SecretKeysResponse getSecrets(@Nonnull Organization organization)
      List of secret keys the are stored for Organization.

      For example 

           github_api_key,
     some_other_key,
     a_secret_key
      Parameters:
      organization - the organization for get secrets
      Returns:
      the secret keys

    • getSecrets

      SecretKeysResponse getSecrets(@Nonnull String orgID)
      List of secret keys the are stored for Organization.

      For example 

           github_api_key,
     some_other_key,
     a_secret_key
      Parameters:
      orgID - the organization for get secrets
      Returns:
      the secret keys

    • putSecrets

      void putSecrets(@Nonnull Map<String,String> secrets, @Nonnull Organization organization)
      Patches all provided secrets and updates any previous values.
      Parameters:
      secrets - secrets to update/add
      organization - the organization for put secrets

    • putSecrets

      void putSecrets(@Nonnull Map<String,String> secrets, @Nonnull String orgID)
      Patches all provided secrets and updates any previous values.
      Parameters:
      secrets - secrets to update/add
      orgID - the organization for put secrets

    • deleteSecrets

      void deleteSecrets(@Nonnull List<String> secrets, @Nonnull Organization organization)
      Delete provided secrets.
      Parameters:
      secrets - secrets to delete
      organization - the organization for delete secrets

    • deleteSecrets

      void deleteSecrets(@Nonnull List<String> secrets, @Nonnull String orgID)
      Delete provided secrets.
      Parameters:
      secrets - secrets to delete
      orgID - the organization for delete secrets

    • deleteSecrets

      void deleteSecrets(@Nonnull SecretKeys secretKeys, @Nonnull String orgID)
      Delete provided secrets.
      Parameters:
      secretKeys - secret key to deleted (required)
      orgID - ID of the organization (required)

    • getMembers

      @Nonnull List<ResourceMember> getMembers(@Nonnull Organization organization)
      List all members of an organization.
      Parameters:
      organization - of the members
      Returns:
      return the List all members of an organization

    • getMembers

      @Nonnull List<ResourceMember> getMembers(@Nonnull String orgID)
      List all members of an organization.
      Parameters:
      orgID - ID of organization to get members
      Returns:
      return the List all members of an organization

    • addMember

      @Nonnull ResourceMember addMember(@Nonnull User member, @Nonnull Organization organization)
      Add organization member.
      Parameters:
      member - the member of an organization
      organization - the organization for the member
      Returns:
      created mapping

    • addMember

      @Nonnull ResourceMember addMember(@Nonnull String memberID, @Nonnull String orgID)
      Add organization member.
      Parameters:
      memberID - the ID of a member
      orgID - the ID of an organization
      Returns:
      created mapping

    • deleteMember

      void deleteMember(@Nonnull User member, @Nonnull Organization organization)
      Removes a member from an organization.
      Parameters:
      member - the member of an organization
      organization - the organization of a member

    • deleteMember

      void deleteMember(@Nonnull String memberID, @Nonnull String orgID)
      Removes a member from an organization.
      Parameters:
      memberID - the ID of a member
      orgID - the ID of an organization

    • getOwners

      @Nonnull List<ResourceOwner> getOwners(@Nonnull Organization organization)
      List all owners of an organization.
      Parameters:
      organization - of the owners
      Returns:
      return the List all owners of an organization

    • getOwners

      @Nonnull List<ResourceOwner> getOwners(@Nonnull String orgID)
      List all owners of an organization.
      Parameters:
      orgID - ID of organization to get owners
      Returns:
      return the List all owners of an organization

    • addOwner

      @Nonnull ResourceOwner addOwner(@Nonnull User owner, @Nonnull Organization organization)
      Add organization owner.
      Parameters:
      owner - the owner of an organization
      organization - the organization of a owner
      Returns:
      created mapping

    • addOwner

      @Nonnull ResourceOwner addOwner(@Nonnull String ownerID, @Nonnull String orgID)
      Add organization owner.
      Parameters:
      ownerID - the ID of a owner
      orgID - the ID of an organization
      Returns:
      created mapping

    • deleteOwner

      void deleteOwner(@Nonnull User owner, @Nonnull Organization organization)
      Removes a owner from an organization.
      Parameters:
      owner - the owner of an organization
      organization - the organization of a owner

    • deleteOwner

      void deleteOwner(@Nonnull String ownerID, @Nonnull String orgID)
      Removes a owner from an organization.
      Parameters:
      ownerID - the ID of a owner
      orgID - the ID of an organization