admin

package
v0.0.0-...-5d1b9c1 Latest Latest
Warning

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

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

Documentation

Overview

Package admin provides access to the Admin Data Transfer API.

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

Usage example:

import "github.com/zippoxer/google-api-go-client/admin/datatransfer/v1"
...
adminService, err := admin.New(oauthHttpClient)

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.
	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 can be used to select the data of the
	// user in this application to be transfered.
	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 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:"-"`
}

Application: The JSON template for an Application resource.

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 transfered in context of this application.
	ApplicationTransferParams []*ApplicationTransferParam `json:"applicationTransferParams,omitempty"`

	// ApplicationTransferStatus: Current status of transfer for this
	// application. (Read-only)
	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 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:"-"`
}

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. eg: 'PRIVACY_LEVEL'
	Key string `json:"key,omitempty"`

	// Value: The value of the coressponding transfer parameter. eg:
	// '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 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:"-"`
}

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

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 (*ApplicationsGetCall) Do

Do executes the "datatransfer.applications.get" call. Exactly one of *Application or error will be non-nil. 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

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

func (*ApplicationsGetCall) IfNoneMatch

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

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 (*ApplicationsGetCall) QuotaUser

func (c *ApplicationsGetCall) QuotaUser(quotaUser string) *ApplicationsGetCall

QuotaUser sets the optional parameter "quotaUser": Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

func (*ApplicationsGetCall) UserIP

func (c *ApplicationsGetCall) UserIP(userIP string) *ApplicationsGetCall

UserIP sets the optional parameter "userIp": IP address of the site where the request originates. Use this if you want to enforce per-user limits.

type ApplicationsListCall

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

func (*ApplicationsListCall) Context

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 (*ApplicationsListCall) CustomerId

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

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

func (*ApplicationsListCall) Do

Do executes the "datatransfer.applications.list" call. Exactly one of *ApplicationsListResponse or error will be non-nil. 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

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

func (*ApplicationsListCall) IfNoneMatch

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

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 (*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) QuotaUser

func (c *ApplicationsListCall) QuotaUser(quotaUser string) *ApplicationsListCall

QuotaUser sets the optional parameter "quotaUser": Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

func (*ApplicationsListCall) UserIP

UserIP sets the optional parameter "userIp": IP address of the site where the request originates. Use this if you want to enforce per-user limits.

type ApplicationsListResponse

type ApplicationsListResponse struct {
	// Applications: 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: Continuation token which will be used to specify next
	// page in list API.
	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 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:"-"`
}

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.

func (*ApplicationsService) List

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

type DataTransfer

type DataTransfer struct {
	// ApplicationDataTransfers: List of per application data transfer
	// resources. It contains data transfer details of the applications
	// associated with this transfer resource. Note that this list is also
	// used to specify 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: The transfer's ID (Read-only).
	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 transfered.
	NewOwnerUserId string `json:"newOwnerUserId,omitempty"`

	// OldOwnerUserId: ID of the user whose data is being transfered.
	OldOwnerUserId string `json:"oldOwnerUserId,omitempty"`

	// OverallTransferStatusCode: Overall transfer status (Read-only).
	OverallTransferStatusCode string `json:"overallTransferStatusCode,omitempty"`

	// RequestTime: The time at which the data transfer was requested
	// (Read-only).
	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 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:"-"`
}

DataTransfer: The JSON template for a DataTransfer resource.

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: Continuation token which will be used to specify next
	// page in list API.
	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 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:"-"`
}

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

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

type TransfersGetCall

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

func (*TransfersGetCall) Context

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 (*TransfersGetCall) Do

func (c *TransfersGetCall) Do() (*DataTransfer, error)

Do executes the "datatransfer.transfers.get" call. Exactly one of *DataTransfer or error will be non-nil. 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

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

func (*TransfersGetCall) IfNoneMatch

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

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 (*TransfersGetCall) QuotaUser

func (c *TransfersGetCall) QuotaUser(quotaUser string) *TransfersGetCall

QuotaUser sets the optional parameter "quotaUser": Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

func (*TransfersGetCall) UserIP

func (c *TransfersGetCall) UserIP(userIP string) *TransfersGetCall

UserIP sets the optional parameter "userIp": IP address of the site where the request originates. Use this if you want to enforce per-user limits.

type TransfersInsertCall

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

func (*TransfersInsertCall) Context

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 (*TransfersInsertCall) Do

Do executes the "datatransfer.transfers.insert" call. Exactly one of *DataTransfer or error will be non-nil. 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

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

func (*TransfersInsertCall) QuotaUser

func (c *TransfersInsertCall) QuotaUser(quotaUser string) *TransfersInsertCall

QuotaUser sets the optional parameter "quotaUser": Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

func (*TransfersInsertCall) UserIP

func (c *TransfersInsertCall) UserIP(userIP string) *TransfersInsertCall

UserIP sets the optional parameter "userIp": IP address of the site where the request originates. Use this if you want to enforce per-user limits.

type TransfersListCall

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

func (*TransfersListCall) Context

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 (*TransfersListCall) CustomerId

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

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

func (*TransfersListCall) Do

Do executes the "datatransfer.transfers.list" call. Exactly one of *DataTransfersListResponse or error will be non-nil. 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

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

func (*TransfersListCall) IfNoneMatch

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

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 (*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) QuotaUser

func (c *TransfersListCall) QuotaUser(quotaUser string) *TransfersListCall

QuotaUser sets the optional parameter "quotaUser": Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

func (*TransfersListCall) Status

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

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

func (*TransfersListCall) UserIP

func (c *TransfersListCall) UserIP(userIP string) *TransfersListCall

UserIP sets the optional parameter "userIp": IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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.

func (*TransfersService) Insert

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

Insert: Inserts a data transfer request.

func (*TransfersService) List

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL