groupsmigration

Documentation

Overview

Package groupsmigration provides access to the Groups Migration API.

See https://developers.google.com/google-apps/groups-migration/

Usage example:

import "google.golang.org/api/groupsmigration/v1"
...
groupsmigrationService, err := groupsmigration.New(oauthHttpClient)

Index

• Constants
• type ArchiveInsertCall
  • func (c *ArchiveInsertCall) Context(ctx context.Context) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) Do() (*Groups, error)
  • func (c *ArchiveInsertCall) Fields(s ...googleapi.Field) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) Media(r io.Reader) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *ArchiveInsertCall
• type ArchiveService
  • func NewArchiveService(s *Service) *ArchiveService
  • func (r *ArchiveService) Insert(groupId string) *ArchiveInsertCall
• type Groups
  • func (s *Groups) MarshalJSON() ([]byte, error)
• type Service
  • func New(client *http.Client) (*Service, error)

Constants

const (
	// Manage messages in groups on your domain
	AppsGroupsMigrationScope = "https://www.googleapis.com/auth/apps.groups.migration"
)

OAuth2 scopes used by this API.

Types

type ArchiveInsertCall

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

func (*ArchiveInsertCall) Context

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

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. This context will supersede any context previously provided to the ResumableMedia method.

func (*ArchiveInsertCall) Do

func (c *ArchiveInsertCall) Do() (*Groups, error)

Do executes the "groupsmigration.archive.insert" call. Exactly one of *Groups or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Groups.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 (*ArchiveInsertCall) Fields

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

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

func (*ArchiveInsertCall) Media

func (c *ArchiveInsertCall) Media(r io.Reader) *ArchiveInsertCall

Media specifies the media to upload in a single chunk. At most one of Media and ResumableMedia may be set.

func (*ArchiveInsertCall) ProgressUpdater

func (c *ArchiveInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *ArchiveInsertCall

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*ArchiveInsertCall) ResumableMedia

func (c *ArchiveInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *ArchiveInsertCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx. At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type ArchiveService

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

func NewArchiveService

func NewArchiveService(s *Service) *ArchiveService

func (*ArchiveService) Insert

func (r *ArchiveService) Insert(groupId string) *ArchiveInsertCall

Insert: Inserts a new mail into the archive of the Google group.

type Groups

type Groups struct {
	// Kind: The kind of insert resource this is.
	Kind string `json:"kind,omitempty"`

	// ResponseCode: The status of the insert request.
	ResponseCode string `json:"responseCode,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Kind") 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:"-"`
}

Groups: JSON response template for groups migration API.

func (*Groups) MarshalJSON

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

type Service

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

	Archive *ArchiveService
	// contains filtered or unexported fields
}

func New

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