groupsmigration

Documentation

Overview

Package groupsmigration provides access to the Groups Migration API.

For product documentation, see: https://developers.google.com/google-apps/groups-migration/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/groupsmigration/v1"
...
ctx := context.Background()
groupsmigrationService, err := groupsmigration.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

groupsmigrationService, err := groupsmigration.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
groupsmigrationService, err := groupsmigration.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

• Constants
• type ArchiveInsertCall
  • func (c *ArchiveInsertCall) Context(ctx context.Context) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) Do(opts ...googleapi.CallOption) (*Groups, error)
  • func (c *ArchiveInsertCall) Fields(s ...googleapi.Field) *ArchiveInsertCall
  • func (c *ArchiveInsertCall) Header() http.Header
  • func (c *ArchiveInsertCall) Media(r io.Reader, options ...googleapi.MediaOption) *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)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Constants

const (
	// Upload messages to any Google group in 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. This context will supersede any context previously provided to the ResumableMedia method.

func (*ArchiveInsertCall) Do

func (c *ArchiveInsertCall) Do(opts ...googleapi.CallOption) (*Groups, error)

Do executes the "groupsmigration.archive.insert" call. 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 details.

func (*ArchiveInsertCall) Header

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

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

func (*ArchiveInsertCall) Media

func (c *ArchiveInsertCall) Media(r io.Reader, options ...googleapi.MediaOption) *ArchiveInsertCall

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. 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.

Deprecated: use Media instead.

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.

- groupId: The group ID.

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []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)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.