admin

package
v0.196.2 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package admin provides access to the Admin SDK API.

For product documentation, see: https://developers.google.com/admin-sdk/

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/admin/datatransfer/v1"
...
ctx := context.Background()
adminService, err := admin.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

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes: 

adminService, err := admin.NewService(ctx, option.WithScopes(admin.AdminDatatransferReadonlyScope))

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

adminService, err := admin.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, ...)
adminService, err := admin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source 
const (
	// View and manage data transfers between users in your organization
	AdminDatatransferScope = "https://www.googleapis.com/auth/admin.datatransfer"

	// View data transfers between users in your organization
	AdminDatatransferReadonlyScope = "https://www.googleapis.com/auth/admin.datatransfer.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Application 

type Application struct {
	// Etag: Etag of the resource.
	Etag string `json:"etag,omitempty"`
	// Id: The application's ID. Retrievable by using the `applications.list()`
	// (/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.
	Id int64 `json:"id,omitempty,string"`
	// Kind: Identifies the resource as a DataTransfer Application Resource.
	Kind string `json:"kind,omitempty"`
	// Name: The application's name.
	Name string `json:"name,omitempty"`
	// TransferParams: The list of all possible transfer parameters for this
	// application. These parameters select which categories of the user's data to
	// transfer.
	TransferParams []*ApplicationTransferParam `json:"transferParams,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`
}

Application: Application resources represent applications installed on the domain that support transferring ownership of user data.

func (Application) MarshalJSON 

func (s Application) MarshalJSON() ([]byte, error)

type ApplicationDataTransfer 

type ApplicationDataTransfer struct {
	// ApplicationId: The application's ID.
	ApplicationId int64 `json:"applicationId,omitempty,string"`
	// ApplicationTransferParams: The transfer parameters for the application.
	// These parameters are used to select the data which will get transferred in
	// context of this application. For more information about the specific values
	// available for each application, see the Transfer parameters
	// (/admin-sdk/data-transfer/v1/parameters) reference.
	ApplicationTransferParams []*ApplicationTransferParam `json:"applicationTransferParams,omitempty"`
	// ApplicationTransferStatus: Read-only. Current status of transfer for this
	// application.
	ApplicationTransferStatus string `json:"applicationTransferStatus,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApplicationId") 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. "ApplicationId") 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:"-"`
}

ApplicationDataTransfer: Template to map fields of ApplicationDataTransfer resource.

func (ApplicationDataTransfer) MarshalJSON 

func (s ApplicationDataTransfer) MarshalJSON() ([]byte, error)

type ApplicationTransferParam 

type ApplicationTransferParam struct {
	// Key: The type of the transfer parameter, such as `PRIVACY_LEVEL`.
	Key string `json:"key,omitempty"`
	// Value: The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
	Value []string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Key") 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. "Key") 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:"-"`
}

ApplicationTransferParam: Template for application transfer parameters.

func (ApplicationTransferParam) MarshalJSON 

func (s ApplicationTransferParam) MarshalJSON() ([]byte, error)

type ApplicationsGetCall 

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

func (*ApplicationsGetCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ApplicationsGetCall) Do 

func (c *ApplicationsGetCall) Do(opts ...googleapi.CallOption) (*Application, error)

Do executes the "datatransfer.applications.get" call. Any non-2xx status code is an error. Response headers are in either *Application.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 (*ApplicationsGetCall) Fields 

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

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

func (*ApplicationsGetCall) Header 

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

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

func (*ApplicationsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ApplicationsListCall 

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

func (*ApplicationsListCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*ApplicationsListCall) CustomerId 

func (c *ApplicationsListCall) CustomerId(customerId string) *ApplicationsListCall

CustomerId sets the optional parameter "customerId": Immutable ID of the Google Workspace account.

func (*ApplicationsListCall) Do 

func (c *ApplicationsListCall) Do(opts ...googleapi.CallOption) (*ApplicationsListResponse, error)

Do executes the "datatransfer.applications.list" call. Any non-2xx status code is an error. Response headers are in either *ApplicationsListResponse.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 (*ApplicationsListCall) Fields 

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

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

func (*ApplicationsListCall) Header 

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

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

func (*ApplicationsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*ApplicationsListCall) MaxResults 

func (c *ApplicationsListCall) MaxResults(maxResults int64) *ApplicationsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return. Default is 100.

func (*ApplicationsListCall) PageToken 

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

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

func (*ApplicationsListCall) Pages 

func (c *ApplicationsListCall) Pages(ctx context.Context, f func(*ApplicationsListResponse) 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 ApplicationsListResponse 

type ApplicationsListResponse struct {
	// Applications: The list of applications that support data transfer and are
	// also installed for the customer.
	Applications []*Application `json:"applications,omitempty"`
	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`
	// Kind: Identifies the resource as a collection of Applications.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token to specify the next page in the list.
	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. "Applications") 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. "Applications") 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:"-"`
}

ApplicationsListResponse: Template for a collection of Applications.

func (ApplicationsListResponse) MarshalJSON 

func (s ApplicationsListResponse) MarshalJSON() ([]byte, error)

type ApplicationsService 

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

func NewApplicationsService 

func NewApplicationsService(s *Service) *ApplicationsService

func (*ApplicationsService) Get 

func (r *ApplicationsService) Get(applicationId int64) *ApplicationsGetCall

Get: Retrieves information about an application for the given application ID.

- applicationId: ID of the application resource to be retrieved.

func (*ApplicationsService) List 

func (r *ApplicationsService) List() *ApplicationsListCall

List: Lists the applications available for data transfer for a customer.

type DataTransfer 

type DataTransfer struct {
	// ApplicationDataTransfers: The list of per-application data transfer
	// resources. It contains details of the applications associated with this
	// transfer resource, and also specifies the applications for which data
	// transfer has to be done at the time of the transfer resource creation.
	ApplicationDataTransfers []*ApplicationDataTransfer `json:"applicationDataTransfers,omitempty"`
	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`
	// Id: Read-only. The transfer's ID.
	Id string `json:"id,omitempty"`
	// Kind: Identifies the resource as a DataTransfer request.
	Kind string `json:"kind,omitempty"`
	// NewOwnerUserId: ID of the user to whom the data is being transferred.
	NewOwnerUserId string `json:"newOwnerUserId,omitempty"`
	// OldOwnerUserId: ID of the user whose data is being transferred.
	OldOwnerUserId string `json:"oldOwnerUserId,omitempty"`
	// OverallTransferStatusCode: Read-only. Overall transfer status.
	OverallTransferStatusCode string `json:"overallTransferStatusCode,omitempty"`
	// RequestTime: Read-only. The time at which the data transfer was requested.
	RequestTime string `json:"requestTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ApplicationDataTransfers")
	// 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. "ApplicationDataTransfers") 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:"-"`
}

DataTransfer: A Transfer resource represents the transfer of the ownership of user data between users.

func (DataTransfer) MarshalJSON 

func (s DataTransfer) MarshalJSON() ([]byte, error)

type DataTransfersListResponse 

type DataTransfersListResponse struct {
	// DataTransfers: List of data transfer requests.
	DataTransfers []*DataTransfer `json:"dataTransfers,omitempty"`
	// Etag: ETag of the resource.
	Etag string `json:"etag,omitempty"`
	// Kind: Identifies the resource as a collection of data transfer requests.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token to specify the next page in the list.
	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. "DataTransfers") 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. "DataTransfers") 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:"-"`
}

DataTransfersListResponse: Template for a collection of DataTransfer resources.

func (DataTransfersListResponse) MarshalJSON 

func (s DataTransfersListResponse) MarshalJSON() ([]byte, error)

type Service 

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

	Applications *ApplicationsService

	Transfers *TransfersService
	// contains filtered or unexported fields
}

func New deprecated 

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.

type TransfersGetCall 

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

func (*TransfersGetCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*TransfersGetCall) Do 

func (c *TransfersGetCall) Do(opts ...googleapi.CallOption) (*DataTransfer, error)

Do executes the "datatransfer.transfers.get" call. Any non-2xx status code is an error. Response headers are in either *DataTransfer.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 (*TransfersGetCall) Fields 

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

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

func (*TransfersGetCall) Header 

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

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

func (*TransfersGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type TransfersInsertCall 

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

func (*TransfersInsertCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*TransfersInsertCall) Do 

func (c *TransfersInsertCall) Do(opts ...googleapi.CallOption) (*DataTransfer, error)

Do executes the "datatransfer.transfers.insert" call. Any non-2xx status code is an error. Response headers are in either *DataTransfer.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 (*TransfersInsertCall) Fields 

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

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

func (*TransfersInsertCall) Header 

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

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

type TransfersListCall 

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

func (*TransfersListCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*TransfersListCall) CustomerId 

func (c *TransfersListCall) CustomerId(customerId string) *TransfersListCall

CustomerId sets the optional parameter "customerId": Immutable ID of the Google Workspace account.

func (*TransfersListCall) Do 

func (c *TransfersListCall) Do(opts ...googleapi.CallOption) (*DataTransfersListResponse, error)

Do executes the "datatransfer.transfers.list" call. Any non-2xx status code is an error. Response headers are in either *DataTransfersListResponse.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 (*TransfersListCall) Fields 

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

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

func (*TransfersListCall) Header 

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

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

func (*TransfersListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*TransfersListCall) MaxResults 

func (c *TransfersListCall) MaxResults(maxResults int64) *TransfersListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return. Default is 100.

func (*TransfersListCall) NewOwnerUserId 

func (c *TransfersListCall) NewOwnerUserId(newOwnerUserId string) *TransfersListCall

NewOwnerUserId sets the optional parameter "newOwnerUserId": Destination user's profile ID.

func (*TransfersListCall) OldOwnerUserId 

func (c *TransfersListCall) OldOwnerUserId(oldOwnerUserId string) *TransfersListCall

OldOwnerUserId sets the optional parameter "oldOwnerUserId": Source user's profile ID.

func (*TransfersListCall) PageToken 

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

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

func (*TransfersListCall) Pages 

func (c *TransfersListCall) Pages(ctx context.Context, f func(*DataTransfersListResponse) 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 (*TransfersListCall) Status 

func (c *TransfersListCall) Status(status string) *TransfersListCall

Status sets the optional parameter "status": Status of the transfer.

type TransfersService 

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

func NewTransfersService 

func NewTransfersService(s *Service) *TransfersService

func (*TransfersService) Get 

func (r *TransfersService) Get(dataTransferId string) *TransfersGetCall

Get: Retrieves a data transfer request by its resource ID.

  • dataTransferId: ID of the resource to be retrieved. This is returned in the response from the insert method.

func (*TransfersService) Insert 

func (r *TransfersService) Insert(datatransfer *DataTransfer) *TransfersInsertCall

Insert: Inserts a data transfer request. See the Transfer parameters (/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.

func (*TransfersService) List 

func (r *TransfersService) List() *TransfersListCall

List: Lists the transfers for a customer by source user, destination user, or status.

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.