OAuth2 scopes used by this API.
const (
// View and manage your data in Google BigQuery and see the email address for
// your Google Account
BigqueryScope = "https://www.googleapis.com/auth/bigquery"
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud services and see the email address of
// your Google Account
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
)
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 CheckValidCredsRequest struct {
}
CheckValidCredsResponse: A response indicating whether the credentials exist and are valid.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HasValidCreds") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CheckValidCredsResponse) MarshalJSON() ([]byte, error)
DataSource: Defines the properties and custom parameters for a data source.
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.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AuthorizationType") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DataSource) MarshalJSON() ([]byte, error)
DataSourceParameter: A parameter used to define custom fields in a data source definition.
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 maximum 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.
// "LIST" - List of strings parameter.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllowedValues") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DataSourceParameter) MarshalJSON() ([]byte, error)
func (s *DataSourceParameter) UnmarshalJSON(data []byte) error
EmailPreferences: Represents preferences for sending email notifications for transfer run events.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EnableFailureEmail") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EmailPreferences) MarshalJSON() ([]byte, error)
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
EncryptionConfiguration: Represents the encryption configuration for a transfer.
type EncryptionConfiguration struct {
// KmsKeyName: The name of the KMS key used for encrypting BigQuery data.
KmsKeyName string `json:"kmsKeyName,omitempty"`
// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "KmsKeyName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EncryptionConfiguration) MarshalJSON() ([]byte, error)
EnrollDataSourcesRequest: A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.
type EnrollDataSourcesRequest struct {
// DataSourceIds: Data sources that are enrolled. It is required to provide at
// least one data source id.
DataSourceIds []string `json:"dataSourceIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataSourceIds") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSourceIds") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnrollDataSourcesRequest) MarshalJSON() ([]byte, error)
ListDataSourcesResponse: Returns list of supported data sources and their metadata.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSources") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListDataSourcesResponse) MarshalJSON() ([]byte, error)
ListLocationsResponse: The response message for Locations.ListLocations.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Locations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)
ListTransferConfigsResponse: The returned list of pipelines in the project.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListTransferConfigsResponse) MarshalJSON() ([]byte, error)
ListTransferLogsResponse: The returned list transfer run messages.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListTransferLogsResponse) MarshalJSON() ([]byte, error)
ListTransferRunsResponse: The returned list of pipelines in the project.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListTransferRunsResponse) MarshalJSON() ([]byte, error)
Location: A resource that represents a Google Cloud 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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Location) MarshalJSON() ([]byte, error)
type ProjectsDataSourcesCheckValidCredsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDataSourcesCheckValidCredsCall) Context(ctx context.Context) *ProjectsDataSourcesCheckValidCredsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDataSourcesCheckValidCredsCall) Do(opts ...googleapi.CallOption) (*CheckValidCredsResponse, error)
Do executes the "bigquerydatatransfer.projects.dataSources.checkValidCreds" call. 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 (c *ProjectsDataSourcesCheckValidCredsCall) Fields(s ...googleapi.Field) *ProjectsDataSourcesCheckValidCredsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDataSourcesCheckValidCredsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsDataSourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDataSourcesGetCall) Context(ctx context.Context) *ProjectsDataSourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDataSourcesGetCall) Do(opts ...googleapi.CallOption) (*DataSource, error)
Do executes the "bigquerydatatransfer.projects.dataSources.get" call. 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 (c *ProjectsDataSourcesGetCall) Fields(s ...googleapi.Field) *ProjectsDataSourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDataSourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsDataSourcesGetCall) IfNoneMatch(entityTag string) *ProjectsDataSourcesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsDataSourcesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDataSourcesListCall) Context(ctx context.Context) *ProjectsDataSourcesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDataSourcesListCall) Do(opts ...googleapi.CallOption) (*ListDataSourcesResponse, error)
Do executes the "bigquerydatatransfer.projects.dataSources.list" call. 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 (c *ProjectsDataSourcesListCall) Fields(s ...googleapi.Field) *ProjectsDataSourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDataSourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsDataSourcesListCall) IfNoneMatch(entityTag string) *ProjectsDataSourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsDataSourcesListCall) PageSize(pageSize int64) *ProjectsDataSourcesListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsDataSourcesListCall) PageToken(pageToken string) *ProjectsDataSourcesListCall
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 (c *ProjectsDataSourcesListCall) Pages(ctx context.Context, f func(*ListDataSourcesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsDataSourcesService struct {
// contains filtered or unexported fields
}
func NewProjectsDataSourcesService(s *Service) *ProjectsDataSourcesService
func (r *ProjectsDataSourcesService) CheckValidCreds(name string, checkvalidcredsrequest *CheckValidCredsRequest) *ProjectsDataSourcesCheckValidCredsCall
CheckValidCreds: Returns true if valid credentials exist for the given data source and requesting user.
func (r *ProjectsDataSourcesService) Get(name string) *ProjectsDataSourcesGetCall
Get: Retrieves a supported data source and returns its settings.
func (r *ProjectsDataSourcesService) List(parent string) *ProjectsDataSourcesListCall
List: Lists supported data sources and returns their settings.
type ProjectsEnrollDataSourcesCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsEnrollDataSourcesCall) Context(ctx context.Context) *ProjectsEnrollDataSourcesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsEnrollDataSourcesCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.enrollDataSources" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsEnrollDataSourcesCall) Fields(s ...googleapi.Field) *ProjectsEnrollDataSourcesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsEnrollDataSourcesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsDataSourcesCheckValidCredsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsDataSourcesCheckValidCredsCall) Context(ctx context.Context) *ProjectsLocationsDataSourcesCheckValidCredsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsDataSourcesCheckValidCredsCall) Do(opts ...googleapi.CallOption) (*CheckValidCredsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds" call. 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 (c *ProjectsLocationsDataSourcesCheckValidCredsCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataSourcesCheckValidCredsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsDataSourcesCheckValidCredsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsDataSourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsDataSourcesGetCall) Context(ctx context.Context) *ProjectsLocationsDataSourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsDataSourcesGetCall) Do(opts ...googleapi.CallOption) (*DataSource, error)
Do executes the "bigquerydatatransfer.projects.locations.dataSources.get" call. 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 (c *ProjectsLocationsDataSourcesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataSourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsDataSourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsDataSourcesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataSourcesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsLocationsDataSourcesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsDataSourcesListCall) Context(ctx context.Context) *ProjectsLocationsDataSourcesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsDataSourcesListCall) Do(opts ...googleapi.CallOption) (*ListDataSourcesResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.dataSources.list" call. 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 (c *ProjectsLocationsDataSourcesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataSourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsDataSourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsDataSourcesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsDataSourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsDataSourcesListCall) PageSize(pageSize int64) *ProjectsLocationsDataSourcesListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsLocationsDataSourcesListCall) PageToken(pageToken string) *ProjectsLocationsDataSourcesListCall
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 (c *ProjectsLocationsDataSourcesListCall) Pages(ctx context.Context, f func(*ListDataSourcesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsDataSourcesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsDataSourcesService(s *Service) *ProjectsLocationsDataSourcesService
func (r *ProjectsLocationsDataSourcesService) CheckValidCreds(name string, checkvalidcredsrequest *CheckValidCredsRequest) *ProjectsLocationsDataSourcesCheckValidCredsCall
CheckValidCreds: Returns true if valid credentials exist for the given data source and requesting user.
func (r *ProjectsLocationsDataSourcesService) Get(name string) *ProjectsLocationsDataSourcesGetCall
Get: Retrieves a supported data source and returns its settings.
func (r *ProjectsLocationsDataSourcesService) List(parent string) *ProjectsLocationsDataSourcesListCall
List: Lists supported data sources and returns their settings.
type ProjectsLocationsEnrollDataSourcesCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsEnrollDataSourcesCall) Context(ctx context.Context) *ProjectsLocationsEnrollDataSourcesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsEnrollDataSourcesCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.locations.enrollDataSources" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsEnrollDataSourcesCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnrollDataSourcesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsEnrollDataSourcesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
Do executes the "bigquerydatatransfer.projects.locations.get" call. 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 (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsLocationsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.list" call. 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 (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
func (c *ProjectsLocationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsService struct {
DataSources *ProjectsLocationsDataSourcesService
TransferConfigs *ProjectsLocationsTransferConfigsService
// contains filtered or unexported fields
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (r *ProjectsLocationsService) EnrollDataSources(name string, enrolldatasourcesrequest *EnrollDataSourcesRequest) *ProjectsLocationsEnrollDataSourcesCall
EnrollDataSources: Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI (https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for BigQuery Web UI (https://cloud.google.com/bigquery/bigquery-web-ui) and Data Transfer Service (https://cloud.google.com/bigquery/docs/working-with-transfers).
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
- name: The resource that owns the locations collection, if applicable.
func (r *ProjectsLocationsService) UnenrollDataSources(name string, unenrolldatasourcesrequest *UnenrollDataSourcesRequest) *ProjectsLocationsUnenrollDataSourcesCall
UnenrollDataSources: Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI (https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled.
type ProjectsLocationsTransferConfigsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsCreateCall) AuthorizationCode(authorizationCode string) *ProjectsLocationsTransferConfigsCreateCall
AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
func (c *ProjectsLocationsTransferConfigsCreateCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsCreateCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.create" call. 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 (c *ProjectsLocationsTransferConfigsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsCreateCall) ServiceAccountName(serviceAccountName string) *ProjectsLocationsTransferConfigsCreateCall
ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts (https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
func (c *ProjectsLocationsTransferConfigsCreateCall) VersionInfo(versionInfo string) *ProjectsLocationsTransferConfigsCreateCall
VersionInfo sets the optional parameter "versionInfo": Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
type ProjectsLocationsTransferConfigsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsDeleteCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsTransferConfigsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsTransferConfigsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsGetCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsGetCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.get" call. 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 (c *ProjectsLocationsTransferConfigsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsTransferConfigsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsLocationsTransferConfigsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsListCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsListCall) DataSourceIds(dataSourceIds ...string) *ProjectsLocationsTransferConfigsListCall
DataSourceIds sets the optional parameter "dataSourceIds": When specified, only configurations of requested data sources are returned.
func (c *ProjectsLocationsTransferConfigsListCall) Do(opts ...googleapi.CallOption) (*ListTransferConfigsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.list" call. 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 (c *ProjectsLocationsTransferConfigsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsTransferConfigsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsTransferConfigsListCall) PageSize(pageSize int64) *ProjectsLocationsTransferConfigsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsLocationsTransferConfigsListCall) PageToken(pageToken string) *ProjectsLocationsTransferConfigsListCall
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 (c *ProjectsLocationsTransferConfigsListCall) Pages(ctx context.Context, f func(*ListTransferConfigsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsTransferConfigsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsPatchCall) AuthorizationCode(authorizationCode string) *ProjectsLocationsTransferConfigsPatchCall
AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
func (c *ProjectsLocationsTransferConfigsPatchCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsPatchCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.patch" call. 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 (c *ProjectsLocationsTransferConfigsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsPatchCall) ServiceAccountName(serviceAccountName string) *ProjectsLocationsTransferConfigsPatchCall
ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts (https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
func (c *ProjectsLocationsTransferConfigsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsTransferConfigsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Required list of fields to be updated in this request.
func (c *ProjectsLocationsTransferConfigsPatchCall) VersionInfo(versionInfo string) *ProjectsLocationsTransferConfigsPatchCall
VersionInfo sets the optional parameter "versionInfo": Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
type ProjectsLocationsTransferConfigsRunsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsRunsDeleteCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsRunsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsRunsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsTransferConfigsRunsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsRunsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsRunsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsTransferConfigsRunsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsRunsGetCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsRunsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsRunsGetCall) Do(opts ...googleapi.CallOption) (*TransferRun, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.get" call. 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 (c *ProjectsLocationsTransferConfigsRunsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsRunsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsRunsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsRunsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsTransferConfigsRunsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsLocationsTransferConfigsRunsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsRunsListCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsRunsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsRunsListCall) Do(opts ...googleapi.CallOption) (*ListTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.list" call. 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 (c *ProjectsLocationsTransferConfigsRunsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsRunsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsRunsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsRunsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsTransferConfigsRunsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsTransferConfigsRunsListCall) PageSize(pageSize int64) *ProjectsLocationsTransferConfigsRunsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsLocationsTransferConfigsRunsListCall) PageToken(pageToken string) *ProjectsLocationsTransferConfigsRunsListCall
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 (c *ProjectsLocationsTransferConfigsRunsListCall) Pages(ctx context.Context, f func(*ListTransferRunsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *ProjectsLocationsTransferConfigsRunsListCall) RunAttempt(runAttempt string) *ProjectsLocationsTransferConfigsRunsListCall
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 (c *ProjectsLocationsTransferConfigsRunsListCall) States(states ...string) *ProjectsLocationsTransferConfigsRunsListCall
States sets the optional parameter "states": When specified, only transfer runs with requested states are returned.
Possible values:
"TRANSFER_STATE_UNSPECIFIED" - State placeholder (0). "PENDING" - Data transfer is scheduled and is waiting to be picked up by
data transfer backend (2).
"RUNNING" - Data transfer is in progress (3). "SUCCEEDED" - Data transfer completed successfully (4). "FAILED" - Data transfer failed (5). "CANCELLED" - Data transfer is cancelled (6).
type ProjectsLocationsTransferConfigsRunsService struct {
TransferLogs *ProjectsLocationsTransferConfigsRunsTransferLogsService
// contains filtered or unexported fields
}
func NewProjectsLocationsTransferConfigsRunsService(s *Service) *ProjectsLocationsTransferConfigsRunsService
func (r *ProjectsLocationsTransferConfigsRunsService) Delete(name string) *ProjectsLocationsTransferConfigsRunsDeleteCall
Delete: Deletes the specified transfer run.
func (r *ProjectsLocationsTransferConfigsRunsService) Get(name string) *ProjectsLocationsTransferConfigsRunsGetCall
Get: Returns information about the particular transfer run.
func (r *ProjectsLocationsTransferConfigsRunsService) List(parent string) *ProjectsLocationsTransferConfigsRunsListCall
List: Returns information about running and completed transfer runs.
type ProjectsLocationsTransferConfigsRunsTransferLogsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Do(opts ...googleapi.CallOption) (*ListTransferLogsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list" call. 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 (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) MessageTypes(messageTypes ...string) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
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 (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) PageSize(pageSize int64) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) PageToken(pageToken string) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
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 (c *ProjectsLocationsTransferConfigsRunsTransferLogsListCall) Pages(ctx context.Context, f func(*ListTransferLogsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsTransferConfigsRunsTransferLogsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsTransferConfigsRunsTransferLogsService(s *Service) *ProjectsLocationsTransferConfigsRunsTransferLogsService
func (r *ProjectsLocationsTransferConfigsRunsTransferLogsService) List(parent string) *ProjectsLocationsTransferConfigsRunsTransferLogsListCall
List: Returns log messages for the transfer run.
type ProjectsLocationsTransferConfigsScheduleRunsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsScheduleRunsCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsScheduleRunsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsScheduleRunsCall) Do(opts ...googleapi.CallOption) (*ScheduleTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns" call. 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 (c *ProjectsLocationsTransferConfigsScheduleRunsCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsScheduleRunsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsScheduleRunsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsTransferConfigsService struct {
Runs *ProjectsLocationsTransferConfigsRunsService
// contains filtered or unexported fields
}
func NewProjectsLocationsTransferConfigsService(s *Service) *ProjectsLocationsTransferConfigsService
func (r *ProjectsLocationsTransferConfigsService) Create(parent string, transferconfig *TransferConfig) *ProjectsLocationsTransferConfigsCreateCall
Create: Creates a new data transfer configuration.
func (r *ProjectsLocationsTransferConfigsService) Delete(name string) *ProjectsLocationsTransferConfigsDeleteCall
Delete: Deletes a data transfer configuration, including any associated transfer runs and logs.
func (r *ProjectsLocationsTransferConfigsService) Get(name string) *ProjectsLocationsTransferConfigsGetCall
Get: Returns information about a data transfer config.
func (r *ProjectsLocationsTransferConfigsService) List(parent string) *ProjectsLocationsTransferConfigsListCall
List: Returns information about all transfer configs owned by a project in the specified location.
func (r *ProjectsLocationsTransferConfigsService) Patch(name string, transferconfig *TransferConfig) *ProjectsLocationsTransferConfigsPatchCall
Patch: Updates a data transfer configuration. All fields must be set, even if they are not updated.
func (r *ProjectsLocationsTransferConfigsService) ScheduleRuns(parent string, scheduletransferrunsrequest *ScheduleTransferRunsRequest) *ProjectsLocationsTransferConfigsScheduleRunsCall
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 (r *ProjectsLocationsTransferConfigsService) StartManualRuns(parent string, startmanualtransferrunsrequest *StartManualTransferRunsRequest) *ProjectsLocationsTransferConfigsStartManualRunsCall
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsTransferConfigsStartManualRunsCall) Context(ctx context.Context) *ProjectsLocationsTransferConfigsStartManualRunsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsTransferConfigsStartManualRunsCall) Do(opts ...googleapi.CallOption) (*StartManualTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns" call. 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 (c *ProjectsLocationsTransferConfigsStartManualRunsCall) Fields(s ...googleapi.Field) *ProjectsLocationsTransferConfigsStartManualRunsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsTransferConfigsStartManualRunsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsUnenrollDataSourcesCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsUnenrollDataSourcesCall) Context(ctx context.Context) *ProjectsLocationsUnenrollDataSourcesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsUnenrollDataSourcesCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.locations.unenrollDataSources" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsUnenrollDataSourcesCall) Fields(s ...googleapi.Field) *ProjectsLocationsUnenrollDataSourcesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsUnenrollDataSourcesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsService struct {
DataSources *ProjectsDataSourcesService
Locations *ProjectsLocationsService
TransferConfigs *ProjectsTransferConfigsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
func (r *ProjectsService) EnrollDataSources(name string, enrolldatasourcesrequest *EnrollDataSourcesRequest) *ProjectsEnrollDataSourcesCall
EnrollDataSources: Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI (https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for BigQuery Web UI (https://cloud.google.com/bigquery/bigquery-web-ui) and Data Transfer Service (https://cloud.google.com/bigquery/docs/working-with-transfers).
type ProjectsTransferConfigsCreateCall struct {
// contains filtered or unexported fields
}
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 only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
func (c *ProjectsTransferConfigsCreateCall) Context(ctx context.Context) *ProjectsTransferConfigsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsCreateCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.create" call. 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 (c *ProjectsTransferConfigsCreateCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsCreateCall) ServiceAccountName(serviceAccountName string) *ProjectsTransferConfigsCreateCall
ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts (https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
func (c *ProjectsTransferConfigsCreateCall) VersionInfo(versionInfo string) *ProjectsTransferConfigsCreateCall
VersionInfo sets the optional parameter "versionInfo": Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
type ProjectsTransferConfigsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsDeleteCall) Context(ctx context.Context) *ProjectsTransferConfigsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsTransferConfigsDeleteCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsTransferConfigsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsGetCall) Context(ctx context.Context) *ProjectsTransferConfigsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsGetCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.get" call. 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 (c *ProjectsTransferConfigsGetCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsTransferConfigsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsListCall) Context(ctx context.Context) *ProjectsTransferConfigsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsListCall) DataSourceIds(dataSourceIds ...string) *ProjectsTransferConfigsListCall
DataSourceIds sets the optional parameter "dataSourceIds": When specified, only configurations of requested data sources are returned.
func (c *ProjectsTransferConfigsListCall) Do(opts ...googleapi.CallOption) (*ListTransferConfigsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.list" call. 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 (c *ProjectsTransferConfigsListCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsTransferConfigsListCall) PageSize(pageSize int64) *ProjectsTransferConfigsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsTransferConfigsListCall) PageToken(pageToken string) *ProjectsTransferConfigsListCall
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 (c *ProjectsTransferConfigsListCall) Pages(ctx context.Context, f func(*ListTransferConfigsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsTransferConfigsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsPatchCall) AuthorizationCode(authorizationCode string) *ProjectsTransferConfigsPatchCall
AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
func (c *ProjectsTransferConfigsPatchCall) Context(ctx context.Context) *ProjectsTransferConfigsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsPatchCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.patch" call. 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 (c *ProjectsTransferConfigsPatchCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsPatchCall) ServiceAccountName(serviceAccountName string) *ProjectsTransferConfigsPatchCall
ServiceAccountName sets the optional parameter "serviceAccountName": Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts (https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
func (c *ProjectsTransferConfigsPatchCall) UpdateMask(updateMask string) *ProjectsTransferConfigsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Required list of fields to be updated in this request.
func (c *ProjectsTransferConfigsPatchCall) VersionInfo(versionInfo string) *ProjectsTransferConfigsPatchCall
VersionInfo sets the optional parameter "versionInfo": Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
type ProjectsTransferConfigsRunsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsRunsDeleteCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsRunsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsTransferConfigsRunsDeleteCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsRunsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsRunsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsTransferConfigsRunsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsRunsGetCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsRunsGetCall) Do(opts ...googleapi.CallOption) (*TransferRun, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.get" call. 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 (c *ProjectsTransferConfigsRunsGetCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsRunsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsRunsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsRunsGetCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsTransferConfigsRunsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsRunsListCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsRunsListCall) Do(opts ...googleapi.CallOption) (*ListTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.list" call. 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 (c *ProjectsTransferConfigsRunsListCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsRunsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsRunsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsRunsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsTransferConfigsRunsListCall) PageSize(pageSize int64) *ProjectsTransferConfigsRunsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsTransferConfigsRunsListCall) PageToken(pageToken string) *ProjectsTransferConfigsRunsListCall
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 (c *ProjectsTransferConfigsRunsListCall) Pages(ctx context.Context, f func(*ListTransferRunsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *ProjectsTransferConfigsRunsListCall) RunAttempt(runAttempt string) *ProjectsTransferConfigsRunsListCall
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 (c *ProjectsTransferConfigsRunsListCall) States(states ...string) *ProjectsTransferConfigsRunsListCall
States sets the optional parameter "states": When specified, only transfer runs with requested states are returned.
Possible values:
"TRANSFER_STATE_UNSPECIFIED" - State placeholder (0). "PENDING" - Data transfer is scheduled and is waiting to be picked up by
data transfer backend (2).
"RUNNING" - Data transfer is in progress (3). "SUCCEEDED" - Data transfer completed successfully (4). "FAILED" - Data transfer failed (5). "CANCELLED" - Data transfer is cancelled (6).
type ProjectsTransferConfigsRunsService struct {
TransferLogs *ProjectsTransferConfigsRunsTransferLogsService
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsRunsService(s *Service) *ProjectsTransferConfigsRunsService
func (r *ProjectsTransferConfigsRunsService) Delete(name string) *ProjectsTransferConfigsRunsDeleteCall
Delete: Deletes the specified transfer run.
func (r *ProjectsTransferConfigsRunsService) Get(name string) *ProjectsTransferConfigsRunsGetCall
Get: Returns information about the particular transfer run.
func (r *ProjectsTransferConfigsRunsService) List(parent string) *ProjectsTransferConfigsRunsListCall
List: Returns information about running and completed transfer runs.
type ProjectsTransferConfigsRunsTransferLogsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsTransferLogsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Do(opts ...googleapi.CallOption) (*ListTransferLogsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list" call. 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 (c *ProjectsTransferConfigsRunsTransferLogsListCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsRunsTransferLogsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsTransferLogsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) MessageTypes(messageTypes ...string) *ProjectsTransferConfigsRunsTransferLogsListCall
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 (c *ProjectsTransferConfigsRunsTransferLogsListCall) PageSize(pageSize int64) *ProjectsTransferConfigsRunsTransferLogsListCall
PageSize sets the optional parameter "pageSize": Page size. The default page size is the maximum value of 1000 results.
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) PageToken(pageToken string) *ProjectsTransferConfigsRunsTransferLogsListCall
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 (c *ProjectsTransferConfigsRunsTransferLogsListCall) Pages(ctx context.Context, f func(*ListTransferLogsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsTransferConfigsRunsTransferLogsService struct {
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsRunsTransferLogsService(s *Service) *ProjectsTransferConfigsRunsTransferLogsService
func (r *ProjectsTransferConfigsRunsTransferLogsService) List(parent string) *ProjectsTransferConfigsRunsTransferLogsListCall
List: Returns log messages for the transfer run.
type ProjectsTransferConfigsScheduleRunsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsScheduleRunsCall) Context(ctx context.Context) *ProjectsTransferConfigsScheduleRunsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsScheduleRunsCall) Do(opts ...googleapi.CallOption) (*ScheduleTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.scheduleRuns" call. 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 (c *ProjectsTransferConfigsScheduleRunsCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsScheduleRunsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsScheduleRunsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsTransferConfigsService struct {
Runs *ProjectsTransferConfigsRunsService
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsService(s *Service) *ProjectsTransferConfigsService
func (r *ProjectsTransferConfigsService) Create(parent string, transferconfig *TransferConfig) *ProjectsTransferConfigsCreateCall
Create: Creates a new data transfer configuration.
func (r *ProjectsTransferConfigsService) Delete(name string) *ProjectsTransferConfigsDeleteCall
Delete: Deletes a data transfer configuration, including any associated transfer runs and logs.
func (r *ProjectsTransferConfigsService) Get(name string) *ProjectsTransferConfigsGetCall
Get: Returns information about a data transfer config.
func (r *ProjectsTransferConfigsService) List(parent string) *ProjectsTransferConfigsListCall
List: Returns information about all transfer configs owned by a project in the specified location.
func (r *ProjectsTransferConfigsService) Patch(name string, transferconfig *TransferConfig) *ProjectsTransferConfigsPatchCall
Patch: Updates a data transfer configuration. All fields must be set, even if they are not updated.
func (r *ProjectsTransferConfigsService) ScheduleRuns(parent string, scheduletransferrunsrequest *ScheduleTransferRunsRequest) *ProjectsTransferConfigsScheduleRunsCall
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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsTransferConfigsStartManualRunsCall) Context(ctx context.Context) *ProjectsTransferConfigsStartManualRunsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsTransferConfigsStartManualRunsCall) Do(opts ...googleapi.CallOption) (*StartManualTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.startManualRuns" call. 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 (c *ProjectsTransferConfigsStartManualRunsCall) Fields(s ...googleapi.Field) *ProjectsTransferConfigsStartManualRunsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsTransferConfigsStartManualRunsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
ScheduleOptions: Options customizing the data transfer schedule.
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 triggered 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 triggered 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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisableAutoScheduling") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScheduleOptions) MarshalJSON() ([]byte, error)
ScheduleTransferRunsRequest: A request to schedule transfer runs for a time range.
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScheduleTransferRunsRequest) MarshalJSON() ([]byte, error)
ScheduleTransferRunsResponse: A response to schedule transfer runs for a time range.
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Runs") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScheduleTransferRunsResponse) MarshalJSON() ([]byte, error)
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
StartManualTransferRunsRequest: A request to start manual transfer runs.
type StartManualTransferRunsRequest struct {
// RequestedRunTime: A run_time timestamp for historical data files or reports
// that are scheduled to be transferred by the scheduled transfer run.
// requested_run_time must be a past time and cannot include future time
// values.
RequestedRunTime string `json:"requestedRunTime,omitempty"`
// RequestedTimeRange: A time_range start and end timestamp for historical data
// files or reports that are scheduled to be transferred by the scheduled
// transfer run. requested_time_range must be a past time and cannot include
// future time values.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequestedRunTime") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StartManualTransferRunsRequest) MarshalJSON() ([]byte, error)
StartManualTransferRunsResponse: A response to start manual transfer runs.
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Runs") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StartManualTransferRunsResponse) MarshalJSON() ([]byte, error)
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).
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
TimeRange: A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TimeRange) MarshalJSON() ([]byte, error)
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.
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. This cannot be changed once data transfer is
// created. The full list of available data source IDs can be returned through
// an API call:
// https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
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 will be
// scheduled for this transfer config.
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"`
// EncryptionConfiguration: The encryption configuration part. Currently, it is
// only used for the optional KMS key name. The BigQuery service account of
// your project must be granted permissions to use the key. Read methods will
// return the key name applied in effect. Write methods will apply the key if
// it is present, or otherwise try to apply project default keys if it is
// absent.
EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`
// Name: Identifier. The resource name of the transfer config. Transfer config
// names have the form either
// `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or
// `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is
// usually a UUID, even though it is not guaranteed or required. The name is
// ignored when creating a transfer config.
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. The format
// for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"`
// OwnerInfo: Output only. Information about the user whose credentials are
// used to transfer data. Populated only for `transferConfigs.get` requests. In
// case the user information is not available, this field will not be
// populated.
OwnerInfo *UserInfo `json:"ownerInfo,omitempty"`
// Params: Parameters specific to each data source. For more information see
// the bq tab in the 'Setting up a data transfer' section for each data source.
// For example the parameters for Cloud Storage transfers are listed here:
// https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
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 minimum interval time between recurring transfers depends on the
// data source; refer to the documentation for your data source.
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 (0).
// "PENDING" - Data transfer is scheduled and is waiting to be picked up by
// data transfer backend (2).
// "RUNNING" - Data transfer is in progress (3).
// "SUCCEEDED" - Data transfer completed successfully (4).
// "FAILED" - Data transfer failed (5).
// "CANCELLED" - Data transfer is cancelled (6).
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataRefreshWindowDays") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TransferConfig) MarshalJSON() ([]byte, error)
TransferMessage: Represents a user facing message for a particular data transfer run.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MessageText") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TransferMessage) MarshalJSON() ([]byte, error)
TransferRun: Represents a data transfer run.
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: Identifier. 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. The format for specifying a
// pubsub topic is: `projects/{project_id}/topics/{topic_id}`
NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"`
// Params: Output only. Parameters specific to each data source. For more
// information see the bq tab in the 'Setting up a data transfer' section for
// each data source. For example the parameters for Cloud Storage transfers are
// listed here:
// https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
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 (0).
// "PENDING" - Data transfer is scheduled and is waiting to be picked up by
// data transfer backend (2).
// "RUNNING" - Data transfer is in progress (3).
// "SUCCEEDED" - Data transfer completed successfully (4).
// "FAILED" - Data transfer failed (5).
// "CANCELLED" - Data transfer is cancelled (6).
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSourceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TransferRun) MarshalJSON() ([]byte, error)
UnenrollDataSourcesRequest: A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.
type UnenrollDataSourcesRequest struct {
// DataSourceIds: Data sources that are unenrolled. It is required to provide
// at least one data source id.
DataSourceIds []string `json:"dataSourceIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataSourceIds") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSourceIds") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UnenrollDataSourcesRequest) MarshalJSON() ([]byte, error)
UserInfo: Information about a user.
type UserInfo struct {
// Email: E-mail address of the user.
Email string `json:"email,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UserInfo) MarshalJSON() ([]byte, error)