dataportability
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package dataportability provides access to the Data Portability API.
For product documentation, see:https://developers.google.com/data-portability
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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/dataportability/v1"...ctx := context.Background()dataportabilityService, err := dataportability.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://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, usegoogle.golang.org/api/option.WithScopes:
dataportabilityService, err := dataportability.NewService(ctx, option.WithScopes(dataportability.DataportabilityYoutubeUnlistedVideosScope))
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
dataportabilityService, err := dataportability.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)dataportabilityService, err := dataportability.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type AccessTypeCheckCall
- func (c *AccessTypeCheckCall) Context(ctx context.Context) *AccessTypeCheckCall
- func (c *AccessTypeCheckCall) Do(opts ...googleapi.CallOption) (*CheckAccessTypeResponse, error)
- func (c *AccessTypeCheckCall) Fields(s ...googleapi.Field) *AccessTypeCheckCall
- func (c *AccessTypeCheckCall) Header() http.Header
- type AccessTypeService
- type ArchiveJobsCancelCall
- func (c *ArchiveJobsCancelCall) Context(ctx context.Context) *ArchiveJobsCancelCall
- func (c *ArchiveJobsCancelCall) Do(opts ...googleapi.CallOption) (*CancelPortabilityArchiveResponse, error)
- func (c *ArchiveJobsCancelCall) Fields(s ...googleapi.Field) *ArchiveJobsCancelCall
- func (c *ArchiveJobsCancelCall) Header() http.Header
- type ArchiveJobsGetPortabilityArchiveStateCall
- func (c *ArchiveJobsGetPortabilityArchiveStateCall) Context(ctx context.Context) *ArchiveJobsGetPortabilityArchiveStateCall
- func (c *ArchiveJobsGetPortabilityArchiveStateCall) Do(opts ...googleapi.CallOption) (*PortabilityArchiveState, error)
- func (c *ArchiveJobsGetPortabilityArchiveStateCall) Fields(s ...googleapi.Field) *ArchiveJobsGetPortabilityArchiveStateCall
- func (c *ArchiveJobsGetPortabilityArchiveStateCall) Header() http.Header
- func (c *ArchiveJobsGetPortabilityArchiveStateCall) IfNoneMatch(entityTag string) *ArchiveJobsGetPortabilityArchiveStateCall
- type ArchiveJobsRetryCall
- func (c *ArchiveJobsRetryCall) Context(ctx context.Context) *ArchiveJobsRetryCall
- func (c *ArchiveJobsRetryCall) Do(opts ...googleapi.CallOption) (*RetryPortabilityArchiveResponse, error)
- func (c *ArchiveJobsRetryCall) Fields(s ...googleapi.Field) *ArchiveJobsRetryCall
- func (c *ArchiveJobsRetryCall) Header() http.Header
- type ArchiveJobsService
- func (r *ArchiveJobsService) Cancel(name string, cancelportabilityarchiverequest *CancelPortabilityArchiveRequest) *ArchiveJobsCancelCall
- func (r *ArchiveJobsService) GetPortabilityArchiveState(name string) *ArchiveJobsGetPortabilityArchiveStateCall
- func (r *ArchiveJobsService) Retry(name string, retryportabilityarchiverequest *RetryPortabilityArchiveRequest) *ArchiveJobsRetryCall
- type AuthorizationResetCall
- func (c *AuthorizationResetCall) Context(ctx context.Context) *AuthorizationResetCall
- func (c *AuthorizationResetCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *AuthorizationResetCall) Fields(s ...googleapi.Field) *AuthorizationResetCall
- func (c *AuthorizationResetCall) Header() http.Header
- type AuthorizationService
- type CancelPortabilityArchiveRequest
- type CancelPortabilityArchiveResponse
- type CheckAccessTypeRequest
- type CheckAccessTypeResponse
- type Empty
- type InitiatePortabilityArchiveRequest
- type InitiatePortabilityArchiveResponse
- type PortabilityArchiveInitiateCall
- func (c *PortabilityArchiveInitiateCall) Context(ctx context.Context) *PortabilityArchiveInitiateCall
- func (c *PortabilityArchiveInitiateCall) Do(opts ...googleapi.CallOption) (*InitiatePortabilityArchiveResponse, error)
- func (c *PortabilityArchiveInitiateCall) Fields(s ...googleapi.Field) *PortabilityArchiveInitiateCall
- func (c *PortabilityArchiveInitiateCall) Header() http.Header
- type PortabilityArchiveService
- type PortabilityArchiveState
- type ResetAuthorizationRequest
- type RetryPortabilityArchiveRequest
- type RetryPortabilityArchiveResponse
- type Service
Constants¶
const (// Move a copy of the Google Alerts subscriptions you createdDataportabilityAlertsSubscriptionsScope = "https://www.googleapis.com/auth/dataportability.alerts.subscriptions"// Move a copy of the information you entered into online forms in ChromeDataportabilityChromeAutofillScope = "https://www.googleapis.com/auth/dataportability.chrome.autofill"// Move a copy of pages you bookmarked in ChromeDataportabilityChromeBookmarksScope = "https://www.googleapis.com/auth/dataportability.chrome.bookmarks"// Move a copy of words you added to Chrome's dictionaryDataportabilityChromeDictionaryScope = "https://www.googleapis.com/auth/dataportability.chrome.dictionary"// Move a copy of extensions you installed from the Chrome Web StoreDataportabilityChromeExtensionsScope = "https://www.googleapis.com/auth/dataportability.chrome.extensions"// Move a copy of sites you visited in ChromeDataportabilityChromeHistoryScope = "https://www.googleapis.com/auth/dataportability.chrome.history"// Move a copy of pages you added to your reading list in ChromeDataportabilityChromeReadingListScope = "https://www.googleapis.com/auth/dataportability.chrome.reading_list"// Move a copy of your settings in ChromeDataportabilityChromeSettingsScope = "https://www.googleapis.com/auth/dataportability.chrome.settings"// Move a copy of searches and sites you follow, saved by DiscoverDataportabilityDiscoverFollowsScope = "https://www.googleapis.com/auth/dataportability.discover.follows"// Move a copy of links to your liked documents, saved by DiscoverDataportabilityDiscoverLikesScope = "https://www.googleapis.com/auth/dataportability.discover.likes"// Move a copy of content you marked as not interested, saved by DiscoverDataportabilityDiscoverNotInterestedScope = "https://www.googleapis.com/auth/dataportability.discover.not_interested"// Move a copy of the places you labeled on MapsDataportabilityMapsAliasedPlacesScope = "https://www.googleapis.com/auth/dataportability.maps.aliased_places"// Move a copy of your pinned trips on MapsDataportabilityMapsCommuteRoutesScope = "https://www.googleapis.com/auth/dataportability.maps.commute_routes"// Move a copy of your commute settings on MapsDataportabilityMapsCommuteSettingsScope = "https://www.googleapis.com/auth/dataportability.maps.commute_settings"// Move a copy of your electric vehicle profile on MapsDataportabilityMapsEvProfileScope = "https://www.googleapis.com/auth/dataportability.maps.ev_profile"// Move a copy of the corrections you made to places or map information on MapsDataportabilityMapsFactualContributionsScope = "https://www.googleapis.com/auth/dataportability.maps.factual_contributions"// Move a copy of your updates to places on MapsDataportabilityMapsOfferingContributionsScope = "https://www.googleapis.com/auth/dataportability.maps.offering_contributions"// Move a copy of the photos and videos you posted on MapsDataportabilityMapsPhotosVideosScope = "https://www.googleapis.com/auth/dataportability.maps.photos_videos"// Move a copy of the questions and answers you posted on MapsDataportabilityMapsQuestionsAnswersScope = "https://www.googleapis.com/auth/dataportability.maps.questions_answers"// Move a copy of your reviews and posts on MapsDataportabilityMapsReviewsScope = "https://www.googleapis.com/auth/dataportability.maps.reviews"// Move a copy of your Starred places list on MapsDataportabilityMapsStarredPlacesScope = "https://www.googleapis.com/auth/dataportability.maps.starred_places"// Move a copy of your vehicle profile on MapsDataportabilityMapsVehicleProfileScope = "https://www.googleapis.com/auth/dataportability.maps.vehicle_profile"// Move a copy of your Maps activityDataportabilityMyactivityMapsScope = "https://www.googleapis.com/auth/dataportability.myactivity.maps"// Move a copy of your My Ad Center activityDataportabilityMyactivityMyadcenterScope = "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter"// Move a copy of your Google Play activityDataportabilityMyactivityPlayScope = "https://www.googleapis.com/auth/dataportability.myactivity.play"// Move a copy of your Google Search activityDataportabilityMyactivitySearchScope = "https://www.googleapis.com/auth/dataportability.myactivity.search"// Move a copy of your Shopping activityDataportabilityMyactivityShoppingScope = "https://www.googleapis.com/auth/dataportability.myactivity.shopping"// Move a copy of your YouTube activityDataportabilityMyactivityYoutubeScope = "https://www.googleapis.com/auth/dataportability.myactivity.youtube"// Move a copy of the maps you created in My MapsDataportabilityMymapsMapsScope = "https://www.googleapis.com/auth/dataportability.mymaps.maps"// Move a copy of your food purchase and reservation activityDataportabilityOrderReservePurchasesReservationsScope = "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations"// Move a copy of information about your devices with Google Play Store// installedDataportabilityPlayDevicesScope = "https://www.googleapis.com/auth/dataportability.play.devices"// Move a copy of your Google Play Store Grouping tags created by app// developersDataportabilityPlayGroupingScope = "https://www.googleapis.com/auth/dataportability.play.grouping"// Move a copy of your Google Play Store app installationsDataportabilityPlayInstallsScope = "https://www.googleapis.com/auth/dataportability.play.installs"// Move a copy of your Google Play Store downloads, including books, games, and// appsDataportabilityPlayLibraryScope = "https://www.googleapis.com/auth/dataportability.play.library"// Move a copy of information about your Google Play Store PointsDataportabilityPlayPlaypointsScope = "https://www.googleapis.com/auth/dataportability.play.playpoints"// Move a copy of information about your Google Play Store promotionsDataportabilityPlayPromotionsScope = "https://www.googleapis.com/auth/dataportability.play.promotions"// Move a copy of your Google Play Store purchasesDataportabilityPlayPurchasesScope = "https://www.googleapis.com/auth/dataportability.play.purchases"// Move a copy of your Google Play Store redemption activitiesDataportabilityPlayRedemptionsScope = "https://www.googleapis.com/auth/dataportability.play.redemptions"// Move a copy of your Google Play Store subscriptionsDataportabilityPlaySubscriptionsScope = "https://www.googleapis.com/auth/dataportability.play.subscriptions"// Move a copy of your Google Play Store user settings and preferencesDataportabilityPlayUsersettingsScope = "https://www.googleapis.com/auth/dataportability.play.usersettings"// Move a copy of your saved links, images, places, and collections from your// use of Google servicesDataportabilitySavedCollectionsScope = "https://www.googleapis.com/auth/dataportability.saved.collections"// Move a copy of your comments on Google SearchDataportabilitySearchUgcCommentsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.comments"// Move a copy of your media reviews on Google SearchDataportabilitySearchUgcMediaReviewsAndStarsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars"// Move a copy of your self-reported video streaming provider preferences from// Google Search and Google TVDataportabilitySearchUgcMediaStreamingVideoProvidersScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers"// Move a copy of your indicated thumbs up and thumbs down on media in Google// Search and Google TVDataportabilitySearchUgcMediaThumbsScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs"// Move a copy of information about the movies and TV shows you marked as// watched on Google Search and Google TVDataportabilitySearchUgcMediaWatchedScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched"// Move a copy of your notification settings on the Google Search appDataportabilitySearchnotificationsSettingsScope = "https://www.googleapis.com/auth/dataportability.searchnotifications.settings"// Move a copy of your notification subscriptions on Google Search appDataportabilitySearchnotificationsSubscriptionsScope = "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions"// Move a copy of your shipping information on ShoppingDataportabilityShoppingAddressesScope = "https://www.googleapis.com/auth/dataportability.shopping.addresses"// Move a copy of reviews you wrote about products or online stores on Google// SearchDataportabilityShoppingReviewsScope = "https://www.googleapis.com/auth/dataportability.shopping.reviews"// Move a copy of the images and videos you uploaded to Street ViewDataportabilityStreetviewImageryScope = "https://www.googleapis.com/auth/dataportability.streetview.imagery"// Move a copy of information about your YouTube channelDataportabilityYoutubeChannelScope = "https://www.googleapis.com/auth/dataportability.youtube.channel"// Move a copy of your YouTube clips metadataDataportabilityYoutubeClipsScope = "https://www.googleapis.com/auth/dataportability.youtube.clips"// Move a copy of your YouTube commentsDataportabilityYoutubeCommentsScope = "https://www.googleapis.com/auth/dataportability.youtube.comments"// Move a copy of all your YouTube messagesDataportabilityYoutubeConversationsScope = "https://www.googleapis.com/auth/dataportability.youtube.conversations"// Move a copy of your YouTube messages in live chatDataportabilityYoutubeLiveChatScope = "https://www.googleapis.com/auth/dataportability.youtube.live_chat"// Move a copy of your uploaded YouTube music tracks and your YouTube music// libraryDataportabilityYoutubeMusicScope = "https://www.googleapis.com/auth/dataportability.youtube.music"// Move a copy of your YouTube playables saved game progress filesDataportabilityYoutubePlayableScope = "https://www.googleapis.com/auth/dataportability.youtube.playable"// Move a copy of your YouTube postsDataportabilityYoutubePostsScope = "https://www.googleapis.com/auth/dataportability.youtube.posts"// Move a copy of your YouTube private playlistsDataportabilityYoutubePrivatePlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.private_playlists"// Move a copy of your private YouTube videos and information about themDataportabilityYoutubePrivateVideosScope = "https://www.googleapis.com/auth/dataportability.youtube.private_videos"// Move a copy of your public YouTube playlistsDataportabilityYoutubePublicPlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.public_playlists"// Move a copy of your public YouTube videos and information about themDataportabilityYoutubePublicVideosScope = "https://www.googleapis.com/auth/dataportability.youtube.public_videos"// Move a copy of your YouTube shopping wishlists, and wishlist itemsDataportabilityYoutubeShoppingScope = "https://www.googleapis.com/auth/dataportability.youtube.shopping"// Move a copy of your YouTube channel subscriptions, even if they're privateDataportabilityYoutubeSubscriptionsScope = "https://www.googleapis.com/auth/dataportability.youtube.subscriptions"// Move a copy of your unlisted YouTube playlistsDataportabilityYoutubeUnlistedPlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists"// Move a copy of your unlisted YouTube videos and information about themDataportabilityYoutubeUnlistedVideosScope = "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccessTypeCheckCall¶added inv0.225.0
type AccessTypeCheckCall struct {// contains filtered or unexported fields}func (*AccessTypeCheckCall)Context¶added inv0.225.0
func (c *AccessTypeCheckCall) Context(ctxcontext.Context) *AccessTypeCheckCall
Context sets the context to be used in this call's Do method.
func (*AccessTypeCheckCall)Do¶added inv0.225.0
func (c *AccessTypeCheckCall) Do(opts ...googleapi.CallOption) (*CheckAccessTypeResponse,error)
Do executes the "dataportability.accessType.check" call.Any non-2xx status code is an error. Response headers are in either*CheckAccessTypeResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*AccessTypeCheckCall)Fields¶added inv0.225.0
func (c *AccessTypeCheckCall) Fields(s ...googleapi.Field) *AccessTypeCheckCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AccessTypeCheckCall)Header¶added inv0.225.0
func (c *AccessTypeCheckCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeAccessTypeService¶added inv0.225.0
type AccessTypeService struct {// contains filtered or unexported fields}funcNewAccessTypeService¶added inv0.225.0
func NewAccessTypeService(s *Service) *AccessTypeService
func (*AccessTypeService)Check¶added inv0.225.0
func (r *AccessTypeService) Check(checkaccesstyperequest *CheckAccessTypeRequest) *AccessTypeCheckCall
Check: Gets the access type of the token.
typeArchiveJobsCancelCall¶added inv0.222.0
type ArchiveJobsCancelCall struct {// contains filtered or unexported fields}func (*ArchiveJobsCancelCall)Context¶added inv0.222.0
func (c *ArchiveJobsCancelCall) Context(ctxcontext.Context) *ArchiveJobsCancelCall
Context sets the context to be used in this call's Do method.
func (*ArchiveJobsCancelCall)Do¶added inv0.222.0
func (c *ArchiveJobsCancelCall) Do(opts ...googleapi.CallOption) (*CancelPortabilityArchiveResponse,error)
Do executes the "dataportability.archiveJobs.cancel" call.Any non-2xx status code is an error. Response headers are in either*CancelPortabilityArchiveResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ArchiveJobsCancelCall)Fields¶added inv0.222.0
func (c *ArchiveJobsCancelCall) Fields(s ...googleapi.Field) *ArchiveJobsCancelCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ArchiveJobsCancelCall)Header¶added inv0.222.0
func (c *ArchiveJobsCancelCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeArchiveJobsGetPortabilityArchiveStateCall¶
type ArchiveJobsGetPortabilityArchiveStateCall struct {// contains filtered or unexported fields}func (*ArchiveJobsGetPortabilityArchiveStateCall)Context¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Context(ctxcontext.Context) *ArchiveJobsGetPortabilityArchiveStateCall
Context sets the context to be used in this call's Do method.
func (*ArchiveJobsGetPortabilityArchiveStateCall)Do¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Do(opts ...googleapi.CallOption) (*PortabilityArchiveState,error)
Do executes the "dataportability.archiveJobs.getPortabilityArchiveState" call.Any non-2xx status code is an error. Response headers are in either*PortabilityArchiveState.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ArchiveJobsGetPortabilityArchiveStateCall)Fields¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Fields(s ...googleapi.Field) *ArchiveJobsGetPortabilityArchiveStateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ArchiveJobsGetPortabilityArchiveStateCall)Header¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ArchiveJobsGetPortabilityArchiveStateCall)IfNoneMatch¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) IfNoneMatch(entityTagstring) *ArchiveJobsGetPortabilityArchiveStateCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeArchiveJobsRetryCall¶
type ArchiveJobsRetryCall struct {// contains filtered or unexported fields}func (*ArchiveJobsRetryCall)Context¶
func (c *ArchiveJobsRetryCall) Context(ctxcontext.Context) *ArchiveJobsRetryCall
Context sets the context to be used in this call's Do method.
func (*ArchiveJobsRetryCall)Do¶
func (c *ArchiveJobsRetryCall) Do(opts ...googleapi.CallOption) (*RetryPortabilityArchiveResponse,error)
Do executes the "dataportability.archiveJobs.retry" call.Any non-2xx status code is an error. Response headers are in either*RetryPortabilityArchiveResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ArchiveJobsRetryCall)Fields¶
func (c *ArchiveJobsRetryCall) Fields(s ...googleapi.Field) *ArchiveJobsRetryCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ArchiveJobsRetryCall)Header¶
func (c *ArchiveJobsRetryCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeArchiveJobsService¶
type ArchiveJobsService struct {// contains filtered or unexported fields}funcNewArchiveJobsService¶
func NewArchiveJobsService(s *Service) *ArchiveJobsService
func (*ArchiveJobsService)Cancel¶added inv0.222.0
func (r *ArchiveJobsService) Cancel(namestring, cancelportabilityarchiverequest *CancelPortabilityArchiveRequest) *ArchiveJobsCancelCall
Cancel: Cancels a Portability Archive job.
- name: The Archive job ID you're canceling. This is returned by theInitiatePortabilityArchive response. The format is:archiveJobs/{archive_job}. Canceling is only executed if the job is inprogress.
func (*ArchiveJobsService)GetPortabilityArchiveState¶
func (r *ArchiveJobsService) GetPortabilityArchiveState(namestring) *ArchiveJobsGetPortabilityArchiveStateCall
GetPortabilityArchiveState: Retrieves the state of an Archive job for thePortability API.
- name: The archive job ID that is returned when you request the state ofthe job. The format is: archiveJobs/{archive_job}/portabilityArchiveState.archive_job is the job ID returned by theInitiatePortabilityArchiveResponse.
func (*ArchiveJobsService)Retry¶
func (r *ArchiveJobsService) Retry(namestring, retryportabilityarchiverequest *RetryPortabilityArchiveRequest) *ArchiveJobsRetryCall
Retry: Retries a failed Portability Archive job.
- name: The Archive job ID you're retrying. This is returned by theInitiatePortabilityArchiveResponse. Retrying is only executed if theinitial job failed.
typeAuthorizationResetCall¶
type AuthorizationResetCall struct {// contains filtered or unexported fields}func (*AuthorizationResetCall)Context¶
func (c *AuthorizationResetCall) Context(ctxcontext.Context) *AuthorizationResetCall
Context sets the context to be used in this call's Do method.
func (*AuthorizationResetCall)Do¶
func (c *AuthorizationResetCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "dataportability.authorization.reset" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*AuthorizationResetCall)Fields¶
func (c *AuthorizationResetCall) Fields(s ...googleapi.Field) *AuthorizationResetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AuthorizationResetCall)Header¶
func (c *AuthorizationResetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeAuthorizationService¶
type AuthorizationService struct {// contains filtered or unexported fields}funcNewAuthorizationService¶
func NewAuthorizationService(s *Service) *AuthorizationService
func (*AuthorizationService)Reset¶
func (r *AuthorizationService) Reset(resetauthorizationrequest *ResetAuthorizationRequest) *AuthorizationResetCall
Reset: Revokes OAuth tokens and resets exhausted scopes for a user/projectpair. This method allows you to initiate a request after a new consent isgranted. This method also indicates that previous archives can be garbagecollected. You should call this method when all jobs are complete and allarchives are downloaded. Do not call it only when you start a new job.
typeCancelPortabilityArchiveRequest¶added inv0.222.0
type CancelPortabilityArchiveRequest struct {}CancelPortabilityArchiveRequest: Request to cancel a Portability Archivejob.
typeCancelPortabilityArchiveResponse¶added inv0.222.0
type CancelPortabilityArchiveResponse struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}CancelPortabilityArchiveResponse: Response to canceling a Data PortabilityArchive job.
typeCheckAccessTypeRequest¶added inv0.225.0
type CheckAccessTypeRequest struct {}CheckAccessTypeRequest: Request to check the token's access type. Allrequired information is derived from the attached OAuth token.
typeCheckAccessTypeResponse¶added inv0.225.0
type CheckAccessTypeResponse struct {// OneTimeResources: Jobs initiated with this token will be one-time if any// requested resources have one-time access.OneTimeResources []string `json:"oneTimeResources,omitempty"`// TimeBasedResources: Jobs initiated with this token will be time-based if all// requested resources have time-based access.TimeBasedResources []string `json:"timeBasedResources,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "OneTimeResources") 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. "OneTimeResources") 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:"-"`}CheckAccessTypeResponse: Response to checking the token's access type.
func (CheckAccessTypeResponse)MarshalJSON¶added inv0.225.0
func (sCheckAccessTypeResponse) MarshalJSON() ([]byte,error)
typeEmpty¶
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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
typeInitiatePortabilityArchiveRequest¶
type InitiatePortabilityArchiveRequest struct {// EndTime: Optional. The timestamp that represents the end point for the data// you are exporting. If the end_time is not specified in the// InitiatePortabilityArchiveRequest, this field is set to the latest available// data.EndTimestring `json:"endTime,omitempty"`// Resources: The resources from which you're exporting data. These values have// a 1:1 correspondence with the OAuth scopes.Resources []string `json:"resources,omitempty"`// StartTime: Optional. The timestamp that represents the starting point for// the data you are exporting. If the start_time is not specified in the// InitiatePortabilityArchiveRequest, the field is set to the earliest// available data.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`}InitiatePortabilityArchiveRequest: Request to kick off an Archive job.
func (InitiatePortabilityArchiveRequest)MarshalJSON¶
func (sInitiatePortabilityArchiveRequest) MarshalJSON() ([]byte,error)
typeInitiatePortabilityArchiveResponse¶
type InitiatePortabilityArchiveResponse struct {// AccessType: The access type of the Archive job initiated by the API.//// Possible values:// "ACCESS_TYPE_UNSPECIFIED" - Default value. This value is unused.// "ACCESS_TYPE_ONE_TIME" - One-time access to the requested scopes.// "ACCESS_TYPE_TIME_BASED" - Multiple exports allowed over 30 days. Enum// value subject to change before launch.AccessTypestring `json:"accessType,omitempty"`// ArchiveJobId: The archive job ID that is initiated in the API. This can be// used to get the state of the job.ArchiveJobIdstring `json:"archiveJobId,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccessType") 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. "AccessType") 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:"-"`}InitiatePortabilityArchiveResponse: Response from initiating an Archive job.
func (InitiatePortabilityArchiveResponse)MarshalJSON¶
func (sInitiatePortabilityArchiveResponse) MarshalJSON() ([]byte,error)
typePortabilityArchiveInitiateCall¶
type PortabilityArchiveInitiateCall struct {// contains filtered or unexported fields}func (*PortabilityArchiveInitiateCall)Context¶
func (c *PortabilityArchiveInitiateCall) Context(ctxcontext.Context) *PortabilityArchiveInitiateCall
Context sets the context to be used in this call's Do method.
func (*PortabilityArchiveInitiateCall)Do¶
func (c *PortabilityArchiveInitiateCall) Do(opts ...googleapi.CallOption) (*InitiatePortabilityArchiveResponse,error)
Do executes the "dataportability.portabilityArchive.initiate" call.Any non-2xx status code is an error. Response headers are in either*InitiatePortabilityArchiveResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*PortabilityArchiveInitiateCall)Fields¶
func (c *PortabilityArchiveInitiateCall) Fields(s ...googleapi.Field) *PortabilityArchiveInitiateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*PortabilityArchiveInitiateCall)Header¶
func (c *PortabilityArchiveInitiateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typePortabilityArchiveService¶
type PortabilityArchiveService struct {// contains filtered or unexported fields}funcNewPortabilityArchiveService¶
func NewPortabilityArchiveService(s *Service) *PortabilityArchiveService
func (*PortabilityArchiveService)Initiate¶
func (r *PortabilityArchiveService) Initiate(initiateportabilityarchiverequest *InitiatePortabilityArchiveRequest) *PortabilityArchiveInitiateCall
Initiate: Initiates a new Archive job for the Portability API.
typePortabilityArchiveState¶
type PortabilityArchiveState struct {// ExportTime: The timestamp that represents the end point for the data you are// exporting. If the end_time value is set in the// InitiatePortabilityArchiveRequest, this field is set to that value. If// end_time is not set, this value is set to the time the export was requested.ExportTimestring `json:"exportTime,omitempty"`// Name: The resource name of ArchiveJob's PortabilityArchiveState singleton.// The format is: archiveJobs/{archive_job}/portabilityArchiveState.// archive_job is the job ID provided in the request.Namestring `json:"name,omitempty"`// StartTime: The timestamp that represents the starting point for the data you// are exporting. This field is set only if the start_time field is specified// in the InitiatePortabilityArchiveRequest.StartTimestring `json:"startTime,omitempty"`// State: Resource that represents the state of the Archive job.//// Possible values:// "STATE_UNSPECIFIED" - Default value. This value is unused.// "IN_PROGRESS" - The job is in progress.// "COMPLETE" - The job is complete.// "FAILED" - The job failed.// "CANCELLED" - The job is cancelled.Statestring `json:"state,omitempty"`// Urls: If the state is complete, this method returns the signed URLs of the// objects in the Cloud Storage bucket.Urls []string `json:"urls,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ExportTime") 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. "ExportTime") 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:"-"`}PortabilityArchiveState: Resource that contains the state of an Archive job.
func (PortabilityArchiveState)MarshalJSON¶
func (sPortabilityArchiveState) MarshalJSON() ([]byte,error)
typeResetAuthorizationRequest¶
type ResetAuthorizationRequest struct {}ResetAuthorizationRequest: Request to reset exhausted OAuth scopes.
typeRetryPortabilityArchiveRequest¶
type RetryPortabilityArchiveRequest struct {}RetryPortabilityArchiveRequest: Request to retry a failed PortabilityArchive job.
typeRetryPortabilityArchiveResponse¶
type RetryPortabilityArchiveResponse struct {// ArchiveJobId: The archive job ID that is initiated by the retry endpoint.// This can be used to get the state of the new job.ArchiveJobIdstring `json:"archiveJobId,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ArchiveJobId") 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. "ArchiveJobId") 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:"-"`}RetryPortabilityArchiveResponse: Response from retrying a PortabilityArchive.
func (RetryPortabilityArchiveResponse)MarshalJSON¶
func (sRetryPortabilityArchiveResponse) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAccessType *AccessTypeServiceArchiveJobs *ArchiveJobsServiceAuthorization *AuthorizationServicePortabilityArchive *PortabilityArchiveService// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶
NewService creates a new Service.
Source Files