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, 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/dataportability/v1beta" ... ctx := context.Background() dataportabilityService, err := dataportability.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:
dataportabilityService, err := dataportability.NewService(ctx, option.WithScopes(dataportability.DataportabilityYoutubeUnlistedVideosScope))
To use an API key for authentication (note: some APIs do not support API keys), use google.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 OAuth flow, use google.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) dataportabilityService, err := dataportability.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- 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
- 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 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 messages between you and the businesses you have // conversations with across Google services. DataportabilityBusinessmessagingConversationsScope = "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations" // Move a copy of the information you entered into online forms in // Chrome. DataportabilityChromeAutofillScope = "https://www.googleapis.com/auth/dataportability.chrome.autofill" // Move a copy of pages you bookmarked in Chrome. DataportabilityChromeBookmarksScope = "https://www.googleapis.com/auth/dataportability.chrome.bookmarks" // Move a copy of words you added to Chrome's dictionary. DataportabilityChromeDictionaryScope = "https://www.googleapis.com/auth/dataportability.chrome.dictionary" // Move a copy of extensions you installed from the Chrome Web Store. DataportabilityChromeExtensionsScope = "https://www.googleapis.com/auth/dataportability.chrome.extensions" // Move a copy of sites you visited in Chrome. DataportabilityChromeHistoryScope = "https://www.googleapis.com/auth/dataportability.chrome.history" // Move a copy of pages you added to your reading list in Chrome. DataportabilityChromeReadingListScope = "https://www.googleapis.com/auth/dataportability.chrome.reading_list" // Move a copy of your settings in Chrome. DataportabilityChromeSettingsScope = "https://www.googleapis.com/auth/dataportability.chrome.settings" // Move a copy of searches and sites you follow, saved by Discover. DataportabilityDiscoverFollowsScope = "https://www.googleapis.com/auth/dataportability.discover.follows" // Move a copy of links to your liked documents, saved by Discover. DataportabilityDiscoverLikesScope = "https://www.googleapis.com/auth/dataportability.discover.likes" // Move a copy of content you marked as not interested, saved by // Discover. DataportabilityDiscoverNotInterestedScope = "https://www.googleapis.com/auth/dataportability.discover.not_interested" // Move a copy of the places you labeled on Maps. DataportabilityMapsAliasedPlacesScope = "https://www.googleapis.com/auth/dataportability.maps.aliased_places" // Move a copy of your pinned trips on Maps. DataportabilityMapsCommuteRoutesScope = "https://www.googleapis.com/auth/dataportability.maps.commute_routes" // Move a copy of your commute settings on Maps. DataportabilityMapsCommuteSettingsScope = "https://www.googleapis.com/auth/dataportability.maps.commute_settings" // Move a copy of your electric vehicle profile on Maps. DataportabilityMapsEvProfileScope = "https://www.googleapis.com/auth/dataportability.maps.ev_profile" // Move a copy of the corrections you made to places or map information // on Maps. DataportabilityMapsFactualContributionsScope = "https://www.googleapis.com/auth/dataportability.maps.factual_contributions" // Move a copy of your updates to places on Maps. DataportabilityMapsOfferingContributionsScope = "https://www.googleapis.com/auth/dataportability.maps.offering_contributions" // Move a copy of the photos and videos you posted on Maps. DataportabilityMapsPhotosVideosScope = "https://www.googleapis.com/auth/dataportability.maps.photos_videos" // Move a copy of the questions and answers you posted on Maps. DataportabilityMapsQuestionsAnswersScope = "https://www.googleapis.com/auth/dataportability.maps.questions_answers" // Move a copy of your reviews and posts on Maps. DataportabilityMapsReviewsScope = "https://www.googleapis.com/auth/dataportability.maps.reviews" // Move a copy of your Starred places list on Maps. DataportabilityMapsStarredPlacesScope = "https://www.googleapis.com/auth/dataportability.maps.starred_places" // Move a copy of your Maps activity. DataportabilityMyactivityMapsScope = "https://www.googleapis.com/auth/dataportability.myactivity.maps" // Move a copy of your My Ad Center activity. DataportabilityMyactivityMyadcenterScope = "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter" // Move a copy of your Google Play activity. DataportabilityMyactivityPlayScope = "https://www.googleapis.com/auth/dataportability.myactivity.play" // Move a copy of your Google Search activity. DataportabilityMyactivitySearchScope = "https://www.googleapis.com/auth/dataportability.myactivity.search" // Move a copy of your Shopping activity. DataportabilityMyactivityShoppingScope = "https://www.googleapis.com/auth/dataportability.myactivity.shopping" // Move a copy of your YouTube activity. DataportabilityMyactivityYoutubeScope = "https://www.googleapis.com/auth/dataportability.myactivity.youtube" // Move a copy of the maps you created in My Maps. DataportabilityMymapsMapsScope = "https://www.googleapis.com/auth/dataportability.mymaps.maps" // Move a copy of your food purchase and reservation activity. DataportabilityOrderReservePurchasesReservationsScope = "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations" // Move a copy of information about your devices with Google Play Store // installed. DataportabilityPlayDevicesScope = "https://www.googleapis.com/auth/dataportability.play.devices" // Move a copy of your Google Play Store Grouping tags created by app // developers. DataportabilityPlayGroupingScope = "https://www.googleapis.com/auth/dataportability.play.grouping" // Move a copy of your Google Play Store app installations. DataportabilityPlayInstallsScope = "https://www.googleapis.com/auth/dataportability.play.installs" // Move a copy of your Google Play Store downloads, including books, // games, and apps. DataportabilityPlayLibraryScope = "https://www.googleapis.com/auth/dataportability.play.library" // Move a copy of information about your Google Play Store Points. DataportabilityPlayPlaypointsScope = "https://www.googleapis.com/auth/dataportability.play.playpoints" // Move a copy of information about your Google Play Store promotions. DataportabilityPlayPromotionsScope = "https://www.googleapis.com/auth/dataportability.play.promotions" // Move a copy of your Google Play Store purchases. DataportabilityPlayPurchasesScope = "https://www.googleapis.com/auth/dataportability.play.purchases" // Move a copy of your Google Play Store redemption activities. DataportabilityPlayRedemptionsScope = "https://www.googleapis.com/auth/dataportability.play.redemptions" // Move a copy of your Google Play Store subscriptions. DataportabilityPlaySubscriptionsScope = "https://www.googleapis.com/auth/dataportability.play.subscriptions" // Move a copy of your Google Play Store user settings and preferences. DataportabilityPlayUsersettingsScope = "https://www.googleapis.com/auth/dataportability.play.usersettings" // Move a copy of your saved links, images, places, and collections from // your use of Google services. DataportabilitySavedCollectionsScope = "https://www.googleapis.com/auth/dataportability.saved.collections" // Move a copy of your media reviews on Google Search. DataportabilitySearchUgcMediaReviewsAndStarsScope = "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 TV. DataportabilitySearchUgcMediaStreamingVideoProvidersScope = "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 TV. DataportabilitySearchUgcMediaThumbsScope = "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 TV. DataportabilitySearchUgcMediaWatchedScope = "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched" // Move a copy of your notification settings on the Google Search app. DataportabilitySearchnotificationsSettingsScope = "https://www.googleapis.com/auth/dataportability.searchnotifications.settings" // Move a copy of your notification subscriptions on Google Search app. DataportabilitySearchnotificationsSubscriptionsScope = "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions" // Move a copy of your shipping information on Shopping. DataportabilityShoppingAddressesScope = "https://www.googleapis.com/auth/dataportability.shopping.addresses" // Move a copy of reviews you wrote about products or online stores on // Google Search. DataportabilityShoppingReviewsScope = "https://www.googleapis.com/auth/dataportability.shopping.reviews" // Move a copy of the images and videos you uploaded to Street View. DataportabilityStreetviewImageryScope = "https://www.googleapis.com/auth/dataportability.streetview.imagery" // Move a copy of information about your YouTube channel. DataportabilityYoutubeChannelScope = "https://www.googleapis.com/auth/dataportability.youtube.channel" // Move a copy of your YouTube comments. DataportabilityYoutubeCommentsScope = "https://www.googleapis.com/auth/dataportability.youtube.comments" // Move a copy of your YouTube messages in live chat. DataportabilityYoutubeLiveChatScope = "https://www.googleapis.com/auth/dataportability.youtube.live_chat" // Move a copy of your uploaded YouTube music tracks and your YouTube // music library. DataportabilityYoutubeMusicScope = "https://www.googleapis.com/auth/dataportability.youtube.music" // Move a copy of your YouTube playables saved game progress files. DataportabilityYoutubePlayableScope = "https://www.googleapis.com/auth/dataportability.youtube.playable" // Move a copy of your YouTube posts. DataportabilityYoutubePostsScope = "https://www.googleapis.com/auth/dataportability.youtube.posts" // Move a copy of your YouTube private playlists. DataportabilityYoutubePrivatePlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.private_playlists" // Move a copy of your private YouTube videos and information about // them. DataportabilityYoutubePrivateVideosScope = "https://www.googleapis.com/auth/dataportability.youtube.private_videos" // Move a copy of your public YouTube playlists. DataportabilityYoutubePublicPlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.public_playlists" // Move a copy of your public YouTube videos and information about them. DataportabilityYoutubePublicVideosScope = "https://www.googleapis.com/auth/dataportability.youtube.public_videos" // Move a copy of your YouTube shopping wishlists, and wishlist items. DataportabilityYoutubeShoppingScope = "https://www.googleapis.com/auth/dataportability.youtube.shopping" // Move a copy of your YouTube channel subscriptions, even if they're // private. DataportabilityYoutubeSubscriptionsScope = "https://www.googleapis.com/auth/dataportability.youtube.subscriptions" // Move a copy of your unlisted YouTube playlists. DataportabilityYoutubeUnlistedPlaylistsScope = "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists" // Move a copy of your unlisted YouTube videos and information about // them. DataportabilityYoutubeUnlistedVideosScope = "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 ¶
type ArchiveJobsGetPortabilityArchiveStateCall ¶
type ArchiveJobsGetPortabilityArchiveStateCall struct {
// contains filtered or unexported fields
}
func (*ArchiveJobsGetPortabilityArchiveStateCall) Context ¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Context(ctx context.Context) *ArchiveJobsGetPortabilityArchiveStateCall
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 (*ArchiveJobsGetPortabilityArchiveStateCall) Do ¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Do(opts ...googleapi.CallOption) (*PortabilityArchiveState, error)
Do executes the "dataportability.archiveJobs.getPortabilityArchiveState" call. Exactly one of *PortabilityArchiveState or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PortabilityArchiveState.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 (*ArchiveJobsGetPortabilityArchiveStateCall) Fields ¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Fields(s ...googleapi.Field) *ArchiveJobsGetPortabilityArchiveStateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ArchiveJobsGetPortabilityArchiveStateCall) Header ¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ArchiveJobsGetPortabilityArchiveStateCall) IfNoneMatch ¶
func (c *ArchiveJobsGetPortabilityArchiveStateCall) IfNoneMatch(entityTag string) *ArchiveJobsGetPortabilityArchiveStateCall
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.
type ArchiveJobsRetryCall ¶
type ArchiveJobsRetryCall struct {
// contains filtered or unexported fields
}
func (*ArchiveJobsRetryCall) Context ¶
func (c *ArchiveJobsRetryCall) Context(ctx context.Context) *ArchiveJobsRetryCall
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 (*ArchiveJobsRetryCall) Do ¶
func (c *ArchiveJobsRetryCall) Do(opts ...googleapi.CallOption) (*RetryPortabilityArchiveResponse, error)
Do executes the "dataportability.archiveJobs.retry" call. Exactly one of *RetryPortabilityArchiveResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RetryPortabilityArchiveResponse.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 (*ArchiveJobsRetryCall) Fields ¶
func (c *ArchiveJobsRetryCall) Fields(s ...googleapi.Field) *ArchiveJobsRetryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ArchiveJobsRetryCall) Header ¶
func (c *ArchiveJobsRetryCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ArchiveJobsService ¶
type ArchiveJobsService struct {
// contains filtered or unexported fields
}
func NewArchiveJobsService ¶
func NewArchiveJobsService(s *Service) *ArchiveJobsService
func (*ArchiveJobsService) GetPortabilityArchiveState ¶
func (r *ArchiveJobsService) GetPortabilityArchiveState(name string) *ArchiveJobsGetPortabilityArchiveStateCall
GetPortabilityArchiveState: Retrieves the state of an Archive job for the Portability API.
- name: The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse.
func (*ArchiveJobsService) Retry ¶
func (r *ArchiveJobsService) Retry(name string, retryportabilityarchiverequest *RetryPortabilityArchiveRequest) *ArchiveJobsRetryCall
Retry: Retries a failed Portability Archive job.
- name: The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed.
type AuthorizationResetCall ¶
type AuthorizationResetCall struct {
// contains filtered or unexported fields
}
func (*AuthorizationResetCall) Context ¶
func (c *AuthorizationResetCall) Context(ctx context.Context) *AuthorizationResetCall
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 (*AuthorizationResetCall) Do ¶
func (c *AuthorizationResetCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "dataportability.authorization.reset" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*AuthorizationResetCall) Fields ¶
func (c *AuthorizationResetCall) Fields(s ...googleapi.Field) *AuthorizationResetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AuthorizationResetCall) Header ¶
func (c *AuthorizationResetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type AuthorizationService ¶
type AuthorizationService struct {
// contains filtered or unexported fields
}
func NewAuthorizationService ¶
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/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.
type Empty ¶
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 defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type InitiatePortabilityArchiveRequest ¶
type InitiatePortabilityArchiveRequest struct { // 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"` // ForceSendFields is a list of field names (e.g. "Resources") to // unconditionally include in API requests. By default, fields with // empty or default 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:"-"` // NullFields is a list of field names (e.g. "Resources") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InitiatePortabilityArchiveRequest: Request to kick off an Archive job.
func (*InitiatePortabilityArchiveRequest) MarshalJSON ¶
func (s *InitiatePortabilityArchiveRequest) MarshalJSON() ([]byte, error)
type InitiatePortabilityArchiveResponse ¶
type InitiatePortabilityArchiveResponse struct { // ArchiveJobId: The archive job ID that is initiated in the API. This // can be used to get the state of the job. ArchiveJobId string `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. 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:"-"` // 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InitiatePortabilityArchiveResponse: Response from initiating an Archive job.
func (*InitiatePortabilityArchiveResponse) MarshalJSON ¶
func (s *InitiatePortabilityArchiveResponse) MarshalJSON() ([]byte, error)
type PortabilityArchiveInitiateCall ¶
type PortabilityArchiveInitiateCall struct {
// contains filtered or unexported fields
}
func (*PortabilityArchiveInitiateCall) Context ¶
func (c *PortabilityArchiveInitiateCall) Context(ctx context.Context) *PortabilityArchiveInitiateCall
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 (*PortabilityArchiveInitiateCall) Do ¶
func (c *PortabilityArchiveInitiateCall) Do(opts ...googleapi.CallOption) (*InitiatePortabilityArchiveResponse, error)
Do executes the "dataportability.portabilityArchive.initiate" call. Exactly one of *InitiatePortabilityArchiveResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *InitiatePortabilityArchiveResponse.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 (*PortabilityArchiveInitiateCall) Fields ¶
func (c *PortabilityArchiveInitiateCall) Fields(s ...googleapi.Field) *PortabilityArchiveInitiateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PortabilityArchiveInitiateCall) Header ¶
func (c *PortabilityArchiveInitiateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PortabilityArchiveService ¶
type PortabilityArchiveService struct {
// contains filtered or unexported fields
}
func NewPortabilityArchiveService ¶
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.
type PortabilityArchiveState ¶
type PortabilityArchiveState struct { // 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. Name string `json:"name,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. State string `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. "Name") to // unconditionally include in API requests. By default, fields with // empty or default 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:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PortabilityArchiveState: Resource that contains the state of an Archive job.
func (*PortabilityArchiveState) MarshalJSON ¶
func (s *PortabilityArchiveState) MarshalJSON() ([]byte, error)
type ResetAuthorizationRequest ¶
type ResetAuthorizationRequest struct { }
ResetAuthorizationRequest: Request to reset exhausted OAuth scopes.
type RetryPortabilityArchiveRequest ¶
type RetryPortabilityArchiveRequest struct { }
RetryPortabilityArchiveRequest: Request to retry a failed Portability Archive job.
type RetryPortabilityArchiveResponse ¶
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. ArchiveJobId string `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. 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:"-"` // 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RetryPortabilityArchiveResponse: Response from retrying a Portability Archive.
func (*RetryPortabilityArchiveResponse) MarshalJSON ¶
func (s *RetryPortabilityArchiveResponse) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment ArchiveJobs *ArchiveJobsService Authorization *AuthorizationService PortabilityArchive *PortabilityArchiveService // contains filtered or unexported fields }
func New
deprecated
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 ¶
NewService creates a new Service.