groups

package
v0.0.0-...-a08bad1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 7, 2019 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package groups provides access to the Enterprise Grade Groups Service.

See https://developers.google.com/admin-sdk/

Usage example: 

import "github.com/nilleb/google-api-go-client/groups/v1alpha"
...
groupsService, err := groups.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage the provisioning of groups on your domain
	AdminDirectoryGroupScope = "https://www.googleapis.com/auth/admin.directory.group"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: 

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty); 

}

The JSON representation for `Empty` is empty JSON object `{}`.

type Group 

type Group struct {
	// Description: Description of the group. Maximum length is 4,096
	// characters.
	Description string `json:"description,omitempty"`

	// DisplayName: Group name
	DisplayName string `json:"displayName,omitempty"`

	// GroupKey: Many times key will be email of a group but its not
	// mandatory to
	// have this key always in email format. Currently we support only
	// email but it will soon support arbitrary strings as key. (Required)
	GroupKey string `json:"groupKey,omitempty"`

	// Name: Unique identifier of Group (Read-only)
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Group: Group Resource. Next available id: 5

func (*Group) MarshalJSON 

func (s *Group) MarshalJSON() ([]byte, error)

type GroupsCreateCall 

type GroupsCreateCall struct {
	// contains filtered or unexported fields
}

func (*GroupsCreateCall) Context 

func (c *GroupsCreateCall) Context(ctx context.Context) *GroupsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsCreateCall) Do 

func (c *GroupsCreateCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "groups.groups.create" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsCreateCall) Fields 

func (c *GroupsCreateCall) Fields(s ...googleapi.Field) *GroupsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsCreateCall) Header 

func (c *GroupsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsDeleteCall 

type GroupsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*GroupsDeleteCall) Context 

func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsDeleteCall) Do 

func (c *GroupsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "groups.groups.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsDeleteCall) Fields 

func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsDeleteCall) Header 

func (c *GroupsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsGetCall 

type GroupsGetCall struct {
	// contains filtered or unexported fields
}

func (*GroupsGetCall) Context 

func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsGetCall) Do 

func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "groups.groups.get" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsGetCall) Fields 

func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsGetCall) Header 

func (c *GroupsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsGetCall) IfNoneMatch 

func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsListCall 

type GroupsListCall struct {
	// contains filtered or unexported fields
}

func (*GroupsListCall) Context 

func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsListCall) Do 

func (c *GroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)

Do executes the "groups.groups.list" call. Exactly one of *ListGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsListCall) DomainName 

func (c *GroupsListCall) DomainName(domainName string) *GroupsListCall

DomainName sets the optional parameter "domainName": If domain is set, result contains list of all Groups for this domain.

func (*GroupsListCall) Fields 

func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsListCall) Header 

func (c *GroupsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsListCall) IfNoneMatch 

func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsListCall) PageSize 

func (c *GroupsListCall) PageSize(pageSize int64) *GroupsListCall

PageSize sets the optional parameter "pageSize": Maximum number of groups to fetch in a request. The max value is 200 and default value is 100.

func (*GroupsListCall) PageToken 

func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall

PageToken sets the optional parameter "pageToken": Token to specify next page in the list.

func (*GroupsListCall) Pages 

func (c *GroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*GroupsListCall) UserKey 

func (c *GroupsListCall) UserKey(userKey string) *GroupsListCall

UserKey sets the optional parameter "userKey": If user_key is set, result contains list of all Groups for this user or group. This value can be any of the user's primary or alias email address, a group's primary or alias email address, or a user's unique ID.

type GroupsMembersCreateCall 

type GroupsMembersCreateCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersCreateCall) Context 

func (c *GroupsMembersCreateCall) Context(ctx context.Context) *GroupsMembersCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersCreateCall) Do 

func (c *GroupsMembersCreateCall) Do(opts ...googleapi.CallOption) (*Member, error)

Do executes the "groups.groups.members.create" call. Exactly one of *Member or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Member.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersCreateCall) Fields 

func (c *GroupsMembersCreateCall) Fields(s ...googleapi.Field) *GroupsMembersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersCreateCall) Header 

func (c *GroupsMembersCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembersDeleteCall 

type GroupsMembersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersDeleteCall) Context 

func (c *GroupsMembersDeleteCall) Context(ctx context.Context) *GroupsMembersDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersDeleteCall) Do 

func (c *GroupsMembersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "groups.groups.members.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersDeleteCall) Fields 

func (c *GroupsMembersDeleteCall) Fields(s ...googleapi.Field) *GroupsMembersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersDeleteCall) Header 

func (c *GroupsMembersDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembersGetCall 

type GroupsMembersGetCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersGetCall) Context 

func (c *GroupsMembersGetCall) Context(ctx context.Context) *GroupsMembersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersGetCall) Do 

func (c *GroupsMembersGetCall) Do(opts ...googleapi.CallOption) (*Member, error)

Do executes the "groups.groups.members.get" call. Exactly one of *Member or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Member.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersGetCall) Fields 

func (c *GroupsMembersGetCall) Fields(s ...googleapi.Field) *GroupsMembersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersGetCall) Header 

func (c *GroupsMembersGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembersGetCall) IfNoneMatch 

func (c *GroupsMembersGetCall) IfNoneMatch(entityTag string) *GroupsMembersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsMembersIsMemberCall 

type GroupsMembersIsMemberCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersIsMemberCall) Context 

func (c *GroupsMembersIsMemberCall) Context(ctx context.Context) *GroupsMembersIsMemberCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersIsMemberCall) Do 

func (c *GroupsMembersIsMemberCall) Do(opts ...googleapi.CallOption) (*IsMemberResponse, error)

Do executes the "groups.groups.members.isMember" call. Exactly one of *IsMemberResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IsMemberResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersIsMemberCall) Fields 

func (c *GroupsMembersIsMemberCall) Fields(s ...googleapi.Field) *GroupsMembersIsMemberCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersIsMemberCall) Header 

func (c *GroupsMembersIsMemberCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembersIsMemberCall) IfNoneMatch 

func (c *GroupsMembersIsMemberCall) IfNoneMatch(entityTag string) *GroupsMembersIsMemberCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsMembersListCall 

type GroupsMembersListCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersListCall) Context 

func (c *GroupsMembersListCall) Context(ctx context.Context) *GroupsMembersListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersListCall) Do 

func (c *GroupsMembersListCall) Do(opts ...googleapi.CallOption) (*ListMembersResponse, error)

Do executes the "groups.groups.members.list" call. Exactly one of *ListMembersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMembersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersListCall) Fields 

func (c *GroupsMembersListCall) Fields(s ...googleapi.Field) *GroupsMembersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersListCall) Header 

func (c *GroupsMembersListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembersListCall) IfNoneMatch 

func (c *GroupsMembersListCall) IfNoneMatch(entityTag string) *GroupsMembersListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembersListCall) PageSize 

func (c *GroupsMembersListCall) PageSize(pageSize int64) *GroupsMembersListCall

PageSize sets the optional parameter "pageSize":

func (*GroupsMembersListCall) PageToken 

func (c *GroupsMembersListCall) PageToken(pageToken string) *GroupsMembersListCall

PageToken sets the optional parameter "pageToken":

func (*GroupsMembersListCall) Pages 

func (c *GroupsMembersListCall) Pages(ctx context.Context, f func(*ListMembersResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type GroupsMembersPatchCall 

type GroupsMembersPatchCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembersPatchCall) Context 

func (c *GroupsMembersPatchCall) Context(ctx context.Context) *GroupsMembersPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembersPatchCall) Do 

func (c *GroupsMembersPatchCall) Do(opts ...googleapi.CallOption) (*Member, error)

Do executes the "groups.groups.members.patch" call. Exactly one of *Member or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Member.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembersPatchCall) Fields 

func (c *GroupsMembersPatchCall) Fields(s ...googleapi.Field) *GroupsMembersPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembersPatchCall) Header 

func (c *GroupsMembersPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembersService 

type GroupsMembersService struct {
	// contains filtered or unexported fields
}

func NewGroupsMembersService 

func NewGroupsMembersService(s *Service) *GroupsMembersService

func (*GroupsMembersService) Create 

func (r *GroupsMembersService) Create(parent string, member *Member) *GroupsMembersCreateCall

Create: Inserts a Member to Group

func (*GroupsMembersService) Delete 

func (r *GroupsMembersService) Delete(name string) *GroupsMembersDeleteCall

Delete: Delete a member.

func (*GroupsMembersService) Get 

func (r *GroupsMembersService) Get(name string) *GroupsMembersGetCall

Get: Gets a membership for given group_key - member_key pair.

func (*GroupsMembersService) IsMember 

func (r *GroupsMembersService) IsMember(name string) *GroupsMembersIsMemberCall

IsMember: Returns whether a given Group has a given member.

func (*GroupsMembersService) List 

func (r *GroupsMembersService) List(parent string) *GroupsMembersListCall

List: List all members for a given group.

func (*GroupsMembersService) Patch 

func (r *GroupsMembersService) Patch(name string, member *Member) *GroupsMembersPatchCall

Patch: Updates a membership

type GroupsPatchCall 

type GroupsPatchCall struct {
	// contains filtered or unexported fields
}

func (*GroupsPatchCall) Context 

func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsPatchCall) Do 

func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "groups.groups.patch" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsPatchCall) Fields 

func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsPatchCall) Header 

func (c *GroupsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsService 

type GroupsService struct {
	Members *GroupsMembersService
	// contains filtered or unexported fields
}

func NewGroupsService 

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService) Create 

func (r *GroupsService) Create(group *Group) *GroupsCreateCall

Create: Creates a Group

func (*GroupsService) Delete 

func (r *GroupsService) Delete(name string) *GroupsDeleteCall

Delete: Delete a Group

func (*GroupsService) Get 

func (r *GroupsService) Get(name string) *GroupsGetCall

Get: Gets a Group for given group key.

func (*GroupsService) List 

func (r *GroupsService) List() *GroupsListCall

List: List all Groups.

func (*GroupsService) Patch 

func (r *GroupsService) Patch(name string, group *Group) *GroupsPatchCall

Patch: Updates a Group

type IsMemberResponse 

type IsMemberResponse struct {
	IsMember bool `json:"isMember,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "IsMember") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IsMember") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*IsMemberResponse) MarshalJSON 

func (s *IsMemberResponse) MarshalJSON() ([]byte, error)

type ListGroupsResponse 

type ListGroupsResponse struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	Resources []*Group `json:"resources,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListGroupsResponse) MarshalJSON 

func (s *ListGroupsResponse) MarshalJSON() ([]byte, error)

type ListMembersResponse 

type ListMembersResponse struct {
	Members []*Member `json:"members,omitempty"`

	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Members") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Members") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListMembersResponse) MarshalJSON 

func (s *ListMembersResponse) MarshalJSON() ([]byte, error)

type Member 

type Member struct {
	// MemberKey: Many times key will be email of a member but its not
	// mandatory to
	// have this key always in email format. Currently we support only
	// email but it will soon support arbitrary strings as key.
	// This is an immutable field. It cannot be changed in
	// UpdateMemberRequest.
	MemberKey string `json:"memberKey,omitempty"`

	// Name: Unique identifier of Member (Read-only)
	Name string `json:"name,omitempty"`

	// Role: Role of the member
	//
	// Possible values:
	//   "UNKNOWN_ROLE"
	//   "MEMBER" - This role can subscribe to a group, and view the
	// group's membership list. The API returns an error for cycles in
	// group
	// memberships. For example, if group1 is a member of group2, group2
	// cannot be
	// a member of group1.
	//   "OWNER" - This role can add or remove members, change
	// member roles, change group's settings, and delete the group. An OWNER
	// must
	// be a member of the group. A group can have more than one OWNER.
	//   "MANAGER" - A MANAGER role can do everything done by an OWNER role
	// except make a member
	// an OWNER or delete the group. A group can have multiple MANAGER
	// members
	Role string `json:"role,omitempty"`

	// Type: Type of the member.
	//
	// Possible values:
	//   "UNKNOWN_TYPE"
	//   "USER"
	//   "GROUP"
	//   "EXTERNAL" - For a member who is not within the same customer as
	// the given group,
	// we should not reveal the type.
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "MemberKey") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MemberKey") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Member: Member Resource. Next available id: 5

func (*Member) MarshalJSON 

func (s *Member) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Groups *GroupsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.