bigquerydatatransfer

package
v0.37.1 Latest Latest
Warning

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

Go to latest
Published: Dec 15, 2020 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package bigquerydatatransfer provides access to the BigQuery Data Transfer API.

For product documentation, see: https://cloud.google.com/bigquery/

Creating a client

Usage example:

import "google.golang.org/api/bigquerydatatransfer/v1"
...
ctx := context.Background()
bigquerydatatransferService, err := bigquerydatatransfer.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 option.WithScopes:

bigquerydatatransferService, err := bigquerydatatransfer.NewService(ctx, option.WithScopes(bigquerydatatransfer.CloudPlatformReadOnlyScope))

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

bigquerydatatransferService, err := bigquerydatatransfer.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data in Google BigQuery
	BigqueryScope = "https://www.googleapis.com/auth/bigquery"

	// View your data in Google BigQuery
	BigqueryReadonlyScope = "https://www.googleapis.com/auth/bigquery.readonly"

	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckValidCredsRequest

type CheckValidCredsRequest struct {
}

CheckValidCredsRequest: A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.

type CheckValidCredsResponse

type CheckValidCredsResponse struct {
	// HasValidCreds: If set to `true`, the credentials exist and are valid.
	HasValidCreds bool `json:"hasValidCreds,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "HasValidCreds") 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:"-"`

	// NullFields is a list of field names (e.g. "HasValidCreds") 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:"-"`
}

CheckValidCredsResponse: A response indicating whether the credentials exist and are valid.

func (*CheckValidCredsResponse) MarshalJSON

func (s *CheckValidCredsResponse) MarshalJSON() ([]byte, error)

type DataSource

type DataSource struct {
	// AuthorizationType: Indicates the type of authorization.
	//
	// Possible values:
	//   "AUTHORIZATION_TYPE_UNSPECIFIED" - Type unspecified.
	//   "AUTHORIZATION_CODE" - Use OAuth 2 authorization codes that can be
	// exchanged for a refresh token on the backend.
	//   "GOOGLE_PLUS_AUTHORIZATION_CODE" - Return an authorization code for
	// a given Google+ page that can then be exchanged for a refresh token
	// on the backend.
	//   "FIRST_PARTY_OAUTH" - Use First Party OAuth based on Loas Owned
	// Clients. First Party OAuth doesn't require a refresh token to get an
	// offline access token. Instead, it uses a client-signed JWT assertion
	// to retrieve an access token.
	AuthorizationType string `json:"authorizationType,omitempty"`

	// ClientId: Data source client id which should be used to receive
	// refresh token.
	ClientId string `json:"clientId,omitempty"`

	// DataRefreshType: Specifies whether the data source supports automatic
	// data refresh for the past few days, and how it's supported. For some
	// data sources, data might not be complete until a few days later, so
	// it's useful to refresh data automatically.
	//
	// Possible values:
	//   "DATA_REFRESH_TYPE_UNSPECIFIED" - The data source won't support
	// data auto refresh, which is default value.
	//   "SLIDING_WINDOW" - The data source supports data auto refresh, and
	// runs will be scheduled for the past few days. Does not allow custom
	// values to be set for each transfer config.
	//   "CUSTOM_SLIDING_WINDOW" - The data source supports data auto
	// refresh, and runs will be scheduled for the past few days. Allows
	// custom values to be set for each transfer config.
	DataRefreshType string `json:"dataRefreshType,omitempty"`

	// DataSourceId: Data source id.
	DataSourceId string `json:"dataSourceId,omitempty"`

	// DefaultDataRefreshWindowDays: Default data refresh window on days.
	// Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
	DefaultDataRefreshWindowDays int64 `json:"defaultDataRefreshWindowDays,omitempty"`

	// DefaultSchedule: Default data transfer schedule. Examples of valid
	// schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of
	// jan,jun 13:15`, and `first sunday of quarter 00:00`.
	DefaultSchedule string `json:"defaultSchedule,omitempty"`

	// Description: User friendly data source description string.
	Description string `json:"description,omitempty"`

	// DisplayName: User friendly data source name.
	DisplayName string `json:"displayName,omitempty"`

	// HelpUrl: Url for the help document for this data source.
	HelpUrl string `json:"helpUrl,omitempty"`

	// ManualRunsDisabled: Disables backfilling and manual run scheduling
	// for the data source.
	ManualRunsDisabled bool `json:"manualRunsDisabled,omitempty"`

	// MinimumScheduleInterval: The minimum interval for scheduler to
	// schedule runs.
	MinimumScheduleInterval string `json:"minimumScheduleInterval,omitempty"`

	// Name: Output only. Data source resource name.
	Name string `json:"name,omitempty"`

	// Parameters: Data source parameters.
	Parameters []*DataSourceParameter `json:"parameters,omitempty"`

	// Scopes: Api auth scopes for which refresh token needs to be obtained.
	// These are scopes needed by a data source to prepare data and ingest
	// them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
	Scopes []string `json:"scopes,omitempty"`

	// SupportsCustomSchedule: Specifies whether the data source supports a
	// user defined schedule, or operates on the default schedule. When set
	// to `true`, user can override default schedule.
	SupportsCustomSchedule bool `json:"supportsCustomSchedule,omitempty"`

	// SupportsMultipleTransfers: Deprecated. This field has no effect.
	SupportsMultipleTransfers bool `json:"supportsMultipleTransfers,omitempty"`

	// TransferType: Deprecated. This field has no effect.
	//
	// Possible values:
	//   "TRANSFER_TYPE_UNSPECIFIED" - Invalid or Unknown transfer type
	// placeholder.
	//   "BATCH" - Batch data transfer.
	//   "STREAMING" - Streaming data transfer. Streaming data source
	// currently doesn't support multiple transfer configs per project.
	TransferType string `json:"transferType,omitempty"`

	// UpdateDeadlineSeconds: The number of seconds to wait for an update
	// from the data source before the Data Transfer Service marks the
	// transfer as FAILED.
	UpdateDeadlineSeconds int64 `json:"updateDeadlineSeconds,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AuthorizationType")
	// 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:"-"`

	// NullFields is a list of field names (e.g. "AuthorizationType") 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:"-"`
}

DataSource: Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

func (*DataSource) MarshalJSON

func (s *DataSource) MarshalJSON() ([]byte, error)

type DataSourceParameter

type DataSourceParameter struct {
	// AllowedValues: All possible values for the parameter.
	AllowedValues []string `json:"allowedValues,omitempty"`

	// Deprecated -- If true, it should not be used in new transfers, and it
	// should not be visible to users.
	Deprecated bool `json:"deprecated,omitempty"`

	// Description: Parameter description.
	Description string `json:"description,omitempty"`

	// DisplayName: Parameter display name in the user interface.
	DisplayName string `json:"displayName,omitempty"`

	// Fields: Deprecated. This field has no effect.
	Fields []*DataSourceParameter `json:"fields,omitempty"`

	// Immutable: Cannot be changed after initial creation.
	Immutable bool `json:"immutable,omitempty"`

	// MaxValue: For integer and double values specifies maxminum allowed
	// value.
	MaxValue float64 `json:"maxValue,omitempty"`

	// MinValue: For integer and double values specifies minimum allowed
	// value.
	MinValue float64 `json:"minValue,omitempty"`

	// ParamId: Parameter identifier.
	ParamId string `json:"paramId,omitempty"`

	// Recurse: Deprecated. This field has no effect.
	Recurse bool `json:"recurse,omitempty"`

	// Repeated: Deprecated. This field has no effect.
	Repeated bool `json:"repeated,omitempty"`

	// Required: Is parameter required.
	Required bool `json:"required,omitempty"`

	// Type: Parameter type.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Type unspecified.
	//   "STRING" - String parameter.
	//   "INTEGER" - Integer parameter (64-bits). Will be serialized to json
	// as string.
	//   "DOUBLE" - Double precision floating point parameter.
	//   "BOOLEAN" - Boolean parameter.
	//   "RECORD" - Deprecated. This field has no effect.
	//   "PLUS_PAGE" - Page ID for a Google+ Page.
	Type string `json:"type,omitempty"`

	// ValidationDescription: Description of the requirements for this
	// field, in case the user input does not fulfill the regex pattern or
	// min/max values.
	ValidationDescription string `json:"validationDescription,omitempty"`

	// ValidationHelpUrl: URL to a help document to further explain the
	// naming requirements.
	ValidationHelpUrl string `json:"validationHelpUrl,omitempty"`

	// ValidationRegex: Regular expression which can be used for parameter
	// validation.
	ValidationRegex string `json:"validationRegex,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AllowedValues") 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:"-"`

	// NullFields is a list of field names (e.g. "AllowedValues") 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:"-"`
}

DataSourceParameter: Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.

func (*DataSourceParameter) MarshalJSON

func (s *DataSourceParameter) MarshalJSON() ([]byte, error)

func (*DataSourceParameter) UnmarshalJSON

func (s *DataSourceParameter) UnmarshalJSON(data []byte) error

type EmailPreferences

type EmailPreferences struct {
	// EnableFailureEmail: If true, email notifications will be sent on
	// transfer run failures.
	EnableFailureEmail bool `json:"enableFailureEmail,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EnableFailureEmail")
	// 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:"-"`

	// NullFields is a list of field names (e.g. "EnableFailureEmail") 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:"-"`
}

EmailPreferences: Represents preferences for sending email notifications for transfer run events.

func (*EmailPreferences) MarshalJSON

func (s *EmailPreferences) MarshalJSON() ([]byte, error)

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); } The JSON representation for `Empty` is empty JSON object `{}`.

type ListDataSourcesResponse

type ListDataSourcesResponse struct {
	// DataSources: List of supported data sources and their transfer
	// settings.
	DataSources []*DataSource `json:"dataSources,omitempty"`

	// NextPageToken: Output only. The next-pagination token. For
	// multiple-page list results, this token can be used as the
	// `ListDataSourcesRequest.page_token` to request the next page of list
	// results.
	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. "DataSources") 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:"-"`

	// NullFields is a list of field names (e.g. "DataSources") 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:"-"`
}

ListDataSourcesResponse: Returns list of supported data sources and their metadata.

func (*ListDataSourcesResponse) MarshalJSON

func (s *ListDataSourcesResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in
	// the request.
	Locations []*Location `json:"locations,omitempty"`

	// NextPageToken: The standard List next-page token.
	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. "Locations") 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:"-"`

	// NullFields is a list of field names (e.g. "Locations") 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:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (*ListLocationsResponse) MarshalJSON

func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListTransferConfigsResponse

type ListTransferConfigsResponse struct {
	// NextPageToken: Output only. The next-pagination token. For
	// multiple-page list results, this token can be used as the
	// `ListTransferConfigsRequest.page_token` to request the next page of
	// list results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TransferConfigs: Output only. The stored pipeline transfer
	// configurations.
	TransferConfigs []*TransferConfig `json:"transferConfigs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") 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:"-"`
}

ListTransferConfigsResponse: The returned list of pipelines in the project.

func (*ListTransferConfigsResponse) MarshalJSON

func (s *ListTransferConfigsResponse) MarshalJSON() ([]byte, error)

type ListTransferLogsResponse

type ListTransferLogsResponse struct {
	// NextPageToken: Output only. The next-pagination token. For
	// multiple-page list results, this token can be used as the
	// `GetTransferRunLogRequest.page_token` to request the next page of
	// list results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TransferMessages: Output only. The stored pipeline transfer messages.
	TransferMessages []*TransferMessage `json:"transferMessages,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") 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:"-"`
}

ListTransferLogsResponse: The returned list transfer run messages.

func (*ListTransferLogsResponse) MarshalJSON

func (s *ListTransferLogsResponse) MarshalJSON() ([]byte, error)

type ListTransferRunsResponse

type ListTransferRunsResponse struct {
	// NextPageToken: Output only. The next-pagination token. For
	// multiple-page list results, this token can be used as the
	// `ListTransferRunsRequest.page_token` to request the next page of list
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TransferRuns: Output only. The stored pipeline transfer runs.
	TransferRuns []*TransferRun `json:"transferRuns,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") 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:"-"`
}

ListTransferRunsResponse: The returned list of pipelines in the project.

func (*ListTransferRunsResponse) MarshalJSON

func (s *ListTransferRunsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby
	// city name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`

	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`

	// LocationId: The canonical id for this location. For example:
	// "us-east1".
	LocationId string `json:"locationId,omitempty"`

	// Metadata: Service-specific metadata. For example the available
	// capacity at the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") 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:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") 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:"-"`
}

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON

func (s *Location) MarshalJSON() ([]byte, error)

type ProjectsDataSourcesCheckValidCredsCall

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

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

Do executes the "bigquerydatatransfer.projects.dataSources.checkValidCreds" call. Exactly one of *CheckValidCredsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CheckValidCredsResponse.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 (*ProjectsDataSourcesCheckValidCredsCall) Fields

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

func (*ProjectsDataSourcesCheckValidCredsCall) Header

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

type ProjectsDataSourcesGetCall

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

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

Do executes the "bigquerydatatransfer.projects.dataSources.get" call. Exactly one of *DataSource or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DataSource.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 (*ProjectsDataSourcesGetCall) Fields

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

func (*ProjectsDataSourcesGetCall) Header

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

func (*ProjectsDataSourcesGetCall) IfNoneMatch

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 ProjectsDataSourcesListCall

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

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

Do executes the "bigquerydatatransfer.projects.dataSources.list" call. Exactly one of *ListDataSourcesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDataSourcesResponse.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 (*ProjectsDataSourcesListCall) Fields

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

func (*ProjectsDataSourcesListCall) Header

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

func (*ProjectsDataSourcesListCall) IfNoneMatch

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 (*ProjectsDataSourcesListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsDataSourcesListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsDataSourcesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsDataSourcesService

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

func NewProjectsDataSourcesService

func NewProjectsDataSourcesService(s *Service) *ProjectsDataSourcesService

func (*ProjectsDataSourcesService) CheckValidCreds

func (r *ProjectsDataSourcesService) CheckValidCreds(name string, checkvalidcredsrequest *CheckValidCredsRequest) *ProjectsDataSourcesCheckValidCredsCall

CheckValidCreds: Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

func (*ProjectsDataSourcesService) Get

Get: Retrieves a supported data source and returns its settings, which can be used for UI rendering.

func (*ProjectsDataSourcesService) List

List: Lists supported data sources and returns their settings, which can be used for UI rendering.

type ProjectsLocationsDataSourcesCheckValidCredsCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds" call. Exactly one of *CheckValidCredsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CheckValidCredsResponse.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 (*ProjectsLocationsDataSourcesCheckValidCredsCall) Fields

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

func (*ProjectsLocationsDataSourcesCheckValidCredsCall) Header

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

type ProjectsLocationsDataSourcesGetCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.dataSources.get" call. Exactly one of *DataSource or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DataSource.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 (*ProjectsLocationsDataSourcesGetCall) Fields

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

func (*ProjectsLocationsDataSourcesGetCall) Header

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

func (*ProjectsLocationsDataSourcesGetCall) IfNoneMatch

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 ProjectsLocationsDataSourcesListCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.dataSources.list" call. Exactly one of *ListDataSourcesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDataSourcesResponse.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 (*ProjectsLocationsDataSourcesListCall) Fields

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

func (*ProjectsLocationsDataSourcesListCall) Header

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

func (*ProjectsLocationsDataSourcesListCall) IfNoneMatch

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 (*ProjectsLocationsDataSourcesListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsLocationsDataSourcesListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsLocationsDataSourcesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDataSourcesService

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

func NewProjectsLocationsDataSourcesService

func NewProjectsLocationsDataSourcesService(s *Service) *ProjectsLocationsDataSourcesService

func (*ProjectsLocationsDataSourcesService) CheckValidCreds

CheckValidCreds: Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

func (*ProjectsLocationsDataSourcesService) Get

Get: Retrieves a supported data source and returns its settings, which can be used for UI rendering.

func (*ProjectsLocationsDataSourcesService) List

List: Lists supported data sources and returns their settings, which can be used for UI rendering.

type ProjectsLocationsGetCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.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 (*ProjectsLocationsGetCall) Fields

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

func (*ProjectsLocationsGetCall) Header

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

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

func (*ProjectsLocationsGetCall) IfNoneMatch

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

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 ProjectsLocationsListCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.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 (*ProjectsLocationsListCall) Fields

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

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsListCall) Header

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

func (*ProjectsLocationsListCall) IfNoneMatch

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

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 (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	DataSources *ProjectsLocationsDataSourcesService

	TransferConfigs *ProjectsLocationsTransferConfigsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

type ProjectsLocationsTransferConfigsCreateCall

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

func (*ProjectsLocationsTransferConfigsCreateCall) AuthorizationCode

AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.create" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsLocationsTransferConfigsCreateCall) Fields

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

func (*ProjectsLocationsTransferConfigsCreateCall) Header

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

func (*ProjectsLocationsTransferConfigsCreateCall) ServiceAccountName

ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

func (*ProjectsLocationsTransferConfigsCreateCall) VersionInfo

VersionInfo sets the optional parameter "versionInfo": Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

type ProjectsLocationsTransferConfigsDeleteCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.delete" 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 (*ProjectsLocationsTransferConfigsDeleteCall) Fields

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

func (*ProjectsLocationsTransferConfigsDeleteCall) Header

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

type ProjectsLocationsTransferConfigsGetCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.get" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsLocationsTransferConfigsGetCall) Fields

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

func (*ProjectsLocationsTransferConfigsGetCall) Header

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

func (*ProjectsLocationsTransferConfigsGetCall) IfNoneMatch

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 ProjectsLocationsTransferConfigsListCall

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

func (*ProjectsLocationsTransferConfigsListCall) 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 (*ProjectsLocationsTransferConfigsListCall) DataSourceIds

DataSourceIds sets the optional parameter "dataSourceIds": When specified, only configurations of requested data sources are returned.

func (*ProjectsLocationsTransferConfigsListCall) Do

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.list" call. Exactly one of *ListTransferConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferConfigsResponse.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 (*ProjectsLocationsTransferConfigsListCall) Fields

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

func (*ProjectsLocationsTransferConfigsListCall) Header

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

func (*ProjectsLocationsTransferConfigsListCall) IfNoneMatch

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 (*ProjectsLocationsTransferConfigsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsLocationsTransferConfigsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsLocationsTransferConfigsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsTransferConfigsPatchCall

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

func (*ProjectsLocationsTransferConfigsPatchCall) AuthorizationCode

AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.patch" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsLocationsTransferConfigsPatchCall) Fields

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

func (*ProjectsLocationsTransferConfigsPatchCall) Header

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

func (*ProjectsLocationsTransferConfigsPatchCall) ServiceAccountName

ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

func (*ProjectsLocationsTransferConfigsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Required list of fields to be updated in this request.

func (*ProjectsLocationsTransferConfigsPatchCall) VersionInfo

VersionInfo sets the optional parameter "versionInfo": Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

type ProjectsLocationsTransferConfigsRunsDeleteCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete" 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 (*ProjectsLocationsTransferConfigsRunsDeleteCall) Fields

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

func (*ProjectsLocationsTransferConfigsRunsDeleteCall) Header

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

type ProjectsLocationsTransferConfigsRunsGetCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.get" call. Exactly one of *TransferRun or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferRun.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 (*ProjectsLocationsTransferConfigsRunsGetCall) Fields

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

func (*ProjectsLocationsTransferConfigsRunsGetCall) Header

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

func (*ProjectsLocationsTransferConfigsRunsGetCall) IfNoneMatch

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 ProjectsLocationsTransferConfigsRunsListCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.list" call. Exactly one of *ListTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferRunsResponse.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 (*ProjectsLocationsTransferConfigsRunsListCall) Fields

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

func (*ProjectsLocationsTransferConfigsRunsListCall) Header

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

func (*ProjectsLocationsTransferConfigsRunsListCall) IfNoneMatch

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 (*ProjectsLocationsTransferConfigsRunsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsLocationsTransferConfigsRunsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsLocationsTransferConfigsRunsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsTransferConfigsRunsListCall) RunAttempt

RunAttempt sets the optional parameter "runAttempt": Indicates how run attempts are to be pulled.

Possible values:

"RUN_ATTEMPT_UNSPECIFIED" - All runs should be returned.
"LATEST" - Only latest run per day should be returned.

func (*ProjectsLocationsTransferConfigsRunsListCall) States

States sets the optional parameter "states": When specified, only transfer runs with requested states are returned.

Possible values:

"TRANSFER_STATE_UNSPECIFIED" - State placeholder.
"PENDING" - Data transfer is scheduled and is waiting to be picked

up by data transfer backend.

"RUNNING" - Data transfer is in progress.
"SUCCEEDED" - Data transfer completed successfully.
"FAILED" - Data transfer failed.
"CANCELLED" - Data transfer is cancelled.

type ProjectsLocationsTransferConfigsRunsService

type ProjectsLocationsTransferConfigsRunsService struct {
	TransferLogs *ProjectsLocationsTransferConfigsRunsTransferLogsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsTransferConfigsRunsService

func NewProjectsLocationsTransferConfigsRunsService(s *Service) *ProjectsLocationsTransferConfigsRunsService

func (*ProjectsLocationsTransferConfigsRunsService) Delete

Delete: Deletes the specified transfer run.

func (*ProjectsLocationsTransferConfigsRunsService) Get

Get: Returns information about the particular transfer run.

func (*ProjectsLocationsTransferConfigsRunsService) List

List: Returns information about running and completed jobs.

type ProjectsLocationsTransferConfigsRunsTransferLogsListCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list" call. Exactly one of *ListTransferLogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferLogsResponse.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 (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Fields

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

func (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Header

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

func (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) IfNoneMatch

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 (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) MessageTypes

MessageTypes sets the optional parameter "messageTypes": Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Possible values:

"MESSAGE_SEVERITY_UNSPECIFIED" - No severity specified.
"INFO" - Informational message.
"WARNING" - Warning message.
"ERROR" - Error message.

func (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsTransferConfigsRunsTransferLogsService

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

func (*ProjectsLocationsTransferConfigsRunsTransferLogsService) List

List: Returns user facing log messages for the data transfer run.

type ProjectsLocationsTransferConfigsScheduleRunsCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns" call. Exactly one of *ScheduleTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ScheduleTransferRunsResponse.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 (*ProjectsLocationsTransferConfigsScheduleRunsCall) Fields

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

func (*ProjectsLocationsTransferConfigsScheduleRunsCall) Header

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

type ProjectsLocationsTransferConfigsService

type ProjectsLocationsTransferConfigsService struct {
	Runs *ProjectsLocationsTransferConfigsRunsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsTransferConfigsService

func NewProjectsLocationsTransferConfigsService(s *Service) *ProjectsLocationsTransferConfigsService

func (*ProjectsLocationsTransferConfigsService) Create

Create: Creates a new data transfer configuration.

func (*ProjectsLocationsTransferConfigsService) Delete

Delete: Deletes a data transfer configuration, including any associated transfer runs and logs.

func (*ProjectsLocationsTransferConfigsService) Get

Get: Returns information about a data transfer config.

func (*ProjectsLocationsTransferConfigsService) List

List: Returns information about all data transfers in the project.

func (*ProjectsLocationsTransferConfigsService) Patch

Patch: Updates a data transfer configuration. All fields must be set, even if they are not updated.

func (*ProjectsLocationsTransferConfigsService) ScheduleRuns

ScheduleRuns: Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

func (*ProjectsLocationsTransferConfigsService) StartManualRuns

StartManualRuns: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

type ProjectsLocationsTransferConfigsStartManualRunsCall

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

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

Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns" call. Exactly one of *StartManualTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *StartManualTransferRunsResponse.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 (*ProjectsLocationsTransferConfigsStartManualRunsCall) Fields

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

func (*ProjectsLocationsTransferConfigsStartManualRunsCall) Header

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

type ProjectsService

type ProjectsService struct {
	DataSources *ProjectsDataSourcesService

	Locations *ProjectsLocationsService

	TransferConfigs *ProjectsTransferConfigsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ProjectsTransferConfigsCreateCall

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

func (*ProjectsTransferConfigsCreateCall) AuthorizationCode

func (c *ProjectsTransferConfigsCreateCall) AuthorizationCode(authorizationCode string) *ProjectsTransferConfigsCreateCall

AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.create" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsTransferConfigsCreateCall) Fields

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

func (*ProjectsTransferConfigsCreateCall) Header

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

func (*ProjectsTransferConfigsCreateCall) ServiceAccountName

func (c *ProjectsTransferConfigsCreateCall) ServiceAccountName(serviceAccountName string) *ProjectsTransferConfigsCreateCall

ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

func (*ProjectsTransferConfigsCreateCall) VersionInfo

VersionInfo sets the optional parameter "versionInfo": Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

type ProjectsTransferConfigsDeleteCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.delete" 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 (*ProjectsTransferConfigsDeleteCall) Fields

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

func (*ProjectsTransferConfigsDeleteCall) Header

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

type ProjectsTransferConfigsGetCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.get" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsTransferConfigsGetCall) Fields

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

func (*ProjectsTransferConfigsGetCall) Header

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

func (*ProjectsTransferConfigsGetCall) IfNoneMatch

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 ProjectsTransferConfigsListCall

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

func (*ProjectsTransferConfigsListCall) 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 (*ProjectsTransferConfigsListCall) DataSourceIds

func (c *ProjectsTransferConfigsListCall) DataSourceIds(dataSourceIds ...string) *ProjectsTransferConfigsListCall

DataSourceIds sets the optional parameter "dataSourceIds": When specified, only configurations of requested data sources are returned.

func (*ProjectsTransferConfigsListCall) Do

Do executes the "bigquerydatatransfer.projects.transferConfigs.list" call. Exactly one of *ListTransferConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferConfigsResponse.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 (*ProjectsTransferConfigsListCall) Fields

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

func (*ProjectsTransferConfigsListCall) Header

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

func (*ProjectsTransferConfigsListCall) IfNoneMatch

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 (*ProjectsTransferConfigsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsTransferConfigsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsTransferConfigsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsTransferConfigsPatchCall

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

func (*ProjectsTransferConfigsPatchCall) AuthorizationCode

func (c *ProjectsTransferConfigsPatchCall) AuthorizationCode(authorizationCode string) *ProjectsTransferConfigsPatchCall

AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.patch" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.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 (*ProjectsTransferConfigsPatchCall) Fields

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

func (*ProjectsTransferConfigsPatchCall) Header

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

func (*ProjectsTransferConfigsPatchCall) ServiceAccountName

func (c *ProjectsTransferConfigsPatchCall) ServiceAccountName(serviceAccountName string) *ProjectsTransferConfigsPatchCall

ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

func (*ProjectsTransferConfigsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Required list of fields to be updated in this request.

func (*ProjectsTransferConfigsPatchCall) VersionInfo

VersionInfo sets the optional parameter "versionInfo": Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

type ProjectsTransferConfigsRunsDeleteCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.delete" 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 (*ProjectsTransferConfigsRunsDeleteCall) Fields

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

func (*ProjectsTransferConfigsRunsDeleteCall) Header

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

type ProjectsTransferConfigsRunsGetCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.get" call. Exactly one of *TransferRun or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferRun.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 (*ProjectsTransferConfigsRunsGetCall) Fields

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

func (*ProjectsTransferConfigsRunsGetCall) Header

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

func (*ProjectsTransferConfigsRunsGetCall) IfNoneMatch

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 ProjectsTransferConfigsRunsListCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.list" call. Exactly one of *ListTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferRunsResponse.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 (*ProjectsTransferConfigsRunsListCall) Fields

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

func (*ProjectsTransferConfigsRunsListCall) Header

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

func (*ProjectsTransferConfigsRunsListCall) IfNoneMatch

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 (*ProjectsTransferConfigsRunsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsTransferConfigsRunsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsTransferConfigsRunsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsTransferConfigsRunsListCall) RunAttempt

RunAttempt sets the optional parameter "runAttempt": Indicates how run attempts are to be pulled.

Possible values:

"RUN_ATTEMPT_UNSPECIFIED" - All runs should be returned.
"LATEST" - Only latest run per day should be returned.

func (*ProjectsTransferConfigsRunsListCall) States

States sets the optional parameter "states": When specified, only transfer runs with requested states are returned.

Possible values:

"TRANSFER_STATE_UNSPECIFIED" - State placeholder.
"PENDING" - Data transfer is scheduled and is waiting to be picked

up by data transfer backend.

"RUNNING" - Data transfer is in progress.
"SUCCEEDED" - Data transfer completed successfully.
"FAILED" - Data transfer failed.
"CANCELLED" - Data transfer is cancelled.

type ProjectsTransferConfigsRunsService

type ProjectsTransferConfigsRunsService struct {
	TransferLogs *ProjectsTransferConfigsRunsTransferLogsService
	// contains filtered or unexported fields
}

func NewProjectsTransferConfigsRunsService

func NewProjectsTransferConfigsRunsService(s *Service) *ProjectsTransferConfigsRunsService

func (*ProjectsTransferConfigsRunsService) Delete

Delete: Deletes the specified transfer run.

func (*ProjectsTransferConfigsRunsService) Get

Get: Returns information about the particular transfer run.

func (*ProjectsTransferConfigsRunsService) List

List: Returns information about running and completed jobs.

type ProjectsTransferConfigsRunsTransferLogsListCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list" call. Exactly one of *ListTransferLogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferLogsResponse.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 (*ProjectsTransferConfigsRunsTransferLogsListCall) Fields

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

func (*ProjectsTransferConfigsRunsTransferLogsListCall) Header

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

func (*ProjectsTransferConfigsRunsTransferLogsListCall) IfNoneMatch

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 (*ProjectsTransferConfigsRunsTransferLogsListCall) MessageTypes

MessageTypes sets the optional parameter "messageTypes": Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Possible values:

"MESSAGE_SEVERITY_UNSPECIFIED" - No severity specified.
"INFO" - Informational message.
"WARNING" - Warning message.
"ERROR" - Error message.

func (*ProjectsTransferConfigsRunsTransferLogsListCall) PageSize

PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.

func (*ProjectsTransferConfigsRunsTransferLogsListCall) PageToken

PageToken sets the optional parameter "pageToken": Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

func (*ProjectsTransferConfigsRunsTransferLogsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsTransferConfigsRunsTransferLogsService

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

func NewProjectsTransferConfigsRunsTransferLogsService

func NewProjectsTransferConfigsRunsTransferLogsService(s *Service) *ProjectsTransferConfigsRunsTransferLogsService

func (*ProjectsTransferConfigsRunsTransferLogsService) List

List: Returns user facing log messages for the data transfer run.

type ProjectsTransferConfigsScheduleRunsCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.scheduleRuns" call. Exactly one of *ScheduleTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ScheduleTransferRunsResponse.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 (*ProjectsTransferConfigsScheduleRunsCall) Fields

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

func (*ProjectsTransferConfigsScheduleRunsCall) Header

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

type ProjectsTransferConfigsService

type ProjectsTransferConfigsService struct {
	Runs *ProjectsTransferConfigsRunsService
	// contains filtered or unexported fields
}

func NewProjectsTransferConfigsService

func NewProjectsTransferConfigsService(s *Service) *ProjectsTransferConfigsService

func (*ProjectsTransferConfigsService) Create

Create: Creates a new data transfer configuration.

func (*ProjectsTransferConfigsService) Delete

Delete: Deletes a data transfer configuration, including any associated transfer runs and logs.

func (*ProjectsTransferConfigsService) Get

Get: Returns information about a data transfer config.

func (*ProjectsTransferConfigsService) List

List: Returns information about all data transfers in the project.

func (*ProjectsTransferConfigsService) Patch

Patch: Updates a data transfer configuration. All fields must be set, even if they are not updated.

func (*ProjectsTransferConfigsService) ScheduleRuns

ScheduleRuns: Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

func (*ProjectsTransferConfigsService) StartManualRuns

func (r *ProjectsTransferConfigsService) StartManualRuns(parent string, startmanualtransferrunsrequest *StartManualTransferRunsRequest) *ProjectsTransferConfigsStartManualRunsCall

StartManualRuns: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

type ProjectsTransferConfigsStartManualRunsCall

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

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

Do executes the "bigquerydatatransfer.projects.transferConfigs.startManualRuns" call. Exactly one of *StartManualTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *StartManualTransferRunsResponse.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 (*ProjectsTransferConfigsStartManualRunsCall) Fields

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

func (*ProjectsTransferConfigsStartManualRunsCall) Header

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

type ScheduleOptions

type ScheduleOptions struct {
	// DisableAutoScheduling: If true, automatic scheduling of data transfer
	// runs for this configuration will be disabled. The runs can be started
	// on ad-hoc basis using StartManualTransferRuns API. When automatic
	// scheduling is disabled, the TransferConfig.schedule field will be
	// ignored.
	DisableAutoScheduling bool `json:"disableAutoScheduling,omitempty"`

	// EndTime: Defines time to stop scheduling transfer runs. A transfer
	// run cannot be scheduled at or after the end time. The end time can be
	// changed at any moment. The time when a data transfer can be trigerred
	// manually is not limited by this option.
	EndTime string `json:"endTime,omitempty"`

	// StartTime: Specifies time to start scheduling transfer runs. The
	// first run will be scheduled at or after the start time according to a
	// recurrence pattern defined in the schedule string. The start time can
	// be changed at any moment. The time when a data transfer can be
	// trigerred manually is not limited by this option.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DisableAutoScheduling") 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:"-"`

	// NullFields is a list of field names (e.g. "DisableAutoScheduling") 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:"-"`
}

ScheduleOptions: Options customizing the data transfer schedule.

func (*ScheduleOptions) MarshalJSON

func (s *ScheduleOptions) MarshalJSON() ([]byte, error)

type ScheduleTransferRunsRequest

type ScheduleTransferRunsRequest struct {
	// EndTime: Required. End time of the range of transfer runs. For
	// example, "2017-05-30T00:00:00+00:00".
	EndTime string `json:"endTime,omitempty"`

	// StartTime: Required. Start time of the range of transfer runs. For
	// example, "2017-05-25T00:00:00+00:00".
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") 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:"-"`

	// 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. 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:"-"`
}

ScheduleTransferRunsRequest: A request to schedule transfer runs for a time range.

func (*ScheduleTransferRunsRequest) MarshalJSON

func (s *ScheduleTransferRunsRequest) MarshalJSON() ([]byte, error)

type ScheduleTransferRunsResponse

type ScheduleTransferRunsResponse struct {
	// Runs: The transfer runs that were scheduled.
	Runs []*TransferRun `json:"runs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Runs") 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:"-"`

	// NullFields is a list of field names (e.g. "Runs") 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:"-"`
}

ScheduleTransferRunsResponse: A response to schedule transfer runs for a time range.

func (*ScheduleTransferRunsResponse) MarshalJSON

func (s *ScheduleTransferRunsResponse) MarshalJSON() ([]byte, error)

type Service

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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

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

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

func NewService

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

NewService creates a new Service.

type StartManualTransferRunsRequest

type StartManualTransferRunsRequest struct {
	// RequestedRunTime: Specific run_time for a transfer run to be started.
	// The requested_run_time must not be in the future.
	RequestedRunTime string `json:"requestedRunTime,omitempty"`

	// RequestedTimeRange: Time range for the transfer runs that should be
	// started.
	RequestedTimeRange *TimeRange `json:"requestedTimeRange,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RequestedRunTime") 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:"-"`

	// NullFields is a list of field names (e.g. "RequestedRunTime") 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:"-"`
}

StartManualTransferRunsRequest: A request to start manual transfer runs.

func (*StartManualTransferRunsRequest) MarshalJSON

func (s *StartManualTransferRunsRequest) MarshalJSON() ([]byte, error)

type StartManualTransferRunsResponse

type StartManualTransferRunsResponse struct {
	// Runs: The transfer runs that were created.
	Runs []*TransferRun `json:"runs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Runs") 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:"-"`

	// NullFields is a list of field names (e.g. "Runs") 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:"-"`
}

StartManualTransferRunsResponse: A response to start manual transfer runs.

func (*StartManualTransferRunsResponse) MarshalJSON

func (s *StartManualTransferRunsResponse) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") 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:"-"`

	// NullFields is a list of field names (e.g. "Code") 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:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type TimeRange

type TimeRange struct {
	// EndTime: End time of the range of transfer runs. For example,
	// "2017-05-30T00:00:00+00:00". The end_time must not be in the
	// future. Creates transfer runs where run_time is in the range between
	// start_time (inclusive) and end_time (exclusive).
	EndTime string `json:"endTime,omitempty"`

	// StartTime: Start time of the range of transfer runs. For example,
	// "2017-05-25T00:00:00+00:00". The start_time must be strictly less
	// than the end_time. Creates transfer runs where run_time is in the
	// range between start_time (inclusive) and end_time (exclusive).
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") 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:"-"`

	// 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. 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:"-"`
}

TimeRange: A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).

func (*TimeRange) MarshalJSON

func (s *TimeRange) MarshalJSON() ([]byte, error)

type TransferConfig

type TransferConfig struct {
	// DataRefreshWindowDays: The number of days to look back to
	// automatically refresh the data. For example, if
	// `data_refresh_window_days = 10`, then every day BigQuery reingests
	// data for [today-10, today-1], rather than ingesting data for just
	// [today-1]. Only valid if the data source supports the feature. Set
	// the value to 0 to use the default value.
	DataRefreshWindowDays int64 `json:"dataRefreshWindowDays,omitempty"`

	// DataSourceId: Data source id. Cannot be changed once data transfer is
	// created.
	DataSourceId string `json:"dataSourceId,omitempty"`

	// DatasetRegion: Output only. Region in which BigQuery dataset is
	// located.
	DatasetRegion string `json:"datasetRegion,omitempty"`

	// DestinationDatasetId: The BigQuery target dataset id.
	DestinationDatasetId string `json:"destinationDatasetId,omitempty"`

	// Disabled: Is this config disabled. When set to true, no runs are
	// scheduled for a given transfer.
	Disabled bool `json:"disabled,omitempty"`

	// DisplayName: User specified display name for the data transfer.
	DisplayName string `json:"displayName,omitempty"`

	// EmailPreferences: Email notifications will be sent according to these
	// preferences to the email address of the user who owns this transfer
	// config.
	EmailPreferences *EmailPreferences `json:"emailPreferences,omitempty"`

	// Name: The resource name of the transfer config. Transfer config names
	// have the form of
	// `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`
	// . The name is automatically generated based on the config_id
	// specified in CreateTransferConfigRequest along with project_id and
	// region. If config_id is not provided, usually a uuid, even though it
	// is not guaranteed or required, will be generated for config_id.
	Name string `json:"name,omitempty"`

	// NextRunTime: Output only. Next time when data transfer will run.
	NextRunTime string `json:"nextRunTime,omitempty"`

	// NotificationPubsubTopic: Pub/Sub topic where notifications will be
	// sent after transfer runs associated with this transfer config finish.
	NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"`

	// Params: Data transfer specific parameters.
	Params googleapi.RawMessage `json:"params,omitempty"`

	// Schedule: Data transfer schedule. If the data source does not support
	// a custom schedule, this should be empty. If it is empty, the default
	// value for the data source will be used. The specified times are in
	// UTC. Examples of valid format: `1st,3rd monday of month 15:30`,
	// `every wed,fri of jan,jun 13:15`, and `first sunday of quarter
	// 00:00`. See more explanation about the format here:
	// https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less
	// frequent.
	Schedule string `json:"schedule,omitempty"`

	// ScheduleOptions: Options customizing the data transfer schedule.
	ScheduleOptions *ScheduleOptions `json:"scheduleOptions,omitempty"`

	// State: Output only. State of the most recently updated transfer run.
	//
	// Possible values:
	//   "TRANSFER_STATE_UNSPECIFIED" - State placeholder.
	//   "PENDING" - Data transfer is scheduled and is waiting to be picked
	// up by data transfer backend.
	//   "RUNNING" - Data transfer is in progress.
	//   "SUCCEEDED" - Data transfer completed successfully.
	//   "FAILED" - Data transfer failed.
	//   "CANCELLED" - Data transfer is cancelled.
	State string `json:"state,omitempty"`

	// UpdateTime: Output only. Data transfer modification time. Ignored by
	// server on input.
	UpdateTime string `json:"updateTime,omitempty"`

	// UserId: Deprecated. Unique ID of the user on whose behalf transfer is
	// done.
	UserId int64 `json:"userId,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "DataRefreshWindowDays") 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:"-"`

	// NullFields is a list of field names (e.g. "DataRefreshWindowDays") 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:"-"`
}

TransferConfig: Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.

func (*TransferConfig) MarshalJSON

func (s *TransferConfig) MarshalJSON() ([]byte, error)

type TransferMessage

type TransferMessage struct {
	// MessageText: Message text.
	MessageText string `json:"messageText,omitempty"`

	// MessageTime: Time when message was logged.
	MessageTime string `json:"messageTime,omitempty"`

	// Severity: Message severity.
	//
	// Possible values:
	//   "MESSAGE_SEVERITY_UNSPECIFIED" - No severity specified.
	//   "INFO" - Informational message.
	//   "WARNING" - Warning message.
	//   "ERROR" - Error message.
	Severity string `json:"severity,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MessageText") 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:"-"`

	// NullFields is a list of field names (e.g. "MessageText") 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:"-"`
}

TransferMessage: Represents a user facing message for a particular data transfer run.

func (*TransferMessage) MarshalJSON

func (s *TransferMessage) MarshalJSON() ([]byte, error)

type TransferRun

type TransferRun struct {
	// DataSourceId: Output only. Data source id.
	DataSourceId string `json:"dataSourceId,omitempty"`

	// DestinationDatasetId: Output only. The BigQuery target dataset id.
	DestinationDatasetId string `json:"destinationDatasetId,omitempty"`

	// EmailPreferences: Output only. Email notifications will be sent
	// according to these preferences to the email address of the user who
	// owns the transfer config this run was derived from.
	EmailPreferences *EmailPreferences `json:"emailPreferences,omitempty"`

	// EndTime: Output only. Time when transfer run ended. Parameter ignored
	// by server for input requests.
	EndTime string `json:"endTime,omitempty"`

	// ErrorStatus: Status of the transfer run.
	ErrorStatus *Status `json:"errorStatus,omitempty"`

	// Name: The resource name of the transfer run. Transfer run names have
	// the form
	// `projects/{project_id}/locations/{location}/transferConfigs/{config_id
	// }/runs/{run_id}`. The name is ignored when creating a transfer run.
	Name string `json:"name,omitempty"`

	// NotificationPubsubTopic: Output only. Pub/Sub topic where a
	// notification will be sent after this transfer run finishes
	NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"`

	// Params: Output only. Data transfer specific parameters.
	Params googleapi.RawMessage `json:"params,omitempty"`

	// RunTime: For batch transfer runs, specifies the date and time of the
	// data should be ingested.
	RunTime string `json:"runTime,omitempty"`

	// Schedule: Output only. Describes the schedule of this transfer run if
	// it was created as part of a regular schedule. For batch transfer runs
	// that are scheduled manually, this is empty. NOTE: the system might
	// choose to delay the schedule depending on the current load, so
	// `schedule_time` doesn't always match this.
	Schedule string `json:"schedule,omitempty"`

	// ScheduleTime: Minimum time after which a transfer run can be started.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// StartTime: Output only. Time when transfer run was started. Parameter
	// ignored by server for input requests.
	StartTime string `json:"startTime,omitempty"`

	// State: Data transfer run state. Ignored for input requests.
	//
	// Possible values:
	//   "TRANSFER_STATE_UNSPECIFIED" - State placeholder.
	//   "PENDING" - Data transfer is scheduled and is waiting to be picked
	// up by data transfer backend.
	//   "RUNNING" - Data transfer is in progress.
	//   "SUCCEEDED" - Data transfer completed successfully.
	//   "FAILED" - Data transfer failed.
	//   "CANCELLED" - Data transfer is cancelled.
	State string `json:"state,omitempty"`

	// UpdateTime: Output only. Last time the data transfer run state was
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// UserId: Deprecated. Unique ID of the user on whose behalf transfer is
	// done.
	UserId int64 `json:"userId,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DataSourceId") 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:"-"`

	// NullFields is a list of field names (e.g. "DataSourceId") 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:"-"`
}

TransferRun: Represents a data transfer run.

func (*TransferRun) MarshalJSON

func (s *TransferRun) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

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