Package bigquerydatatransfer
Overview ▹
Index ▹
Constants
OAuth2 scopes used by this API.
const (
// View and manage your data in Google BigQuery
BigqueryScope = "https://www.googleapis.com/auth/bigquery"
)
type CheckValidCredsRequest ¶
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 { }
type CheckValidCredsResponse ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HasValidCreds") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*CheckValidCredsResponse) MarshalJSON ¶
func (s *CheckValidCredsResponse) MarshalJSON() ([]byte, error)
type DataSource ¶
DataSource: Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
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. AuthorizationType string `json:"authorizationType,omitempty"` // ClientId: Data source client id which should be used to receive // refresh token. // When not supplied, no offline credentials are populated for data // transfer. 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: // "NONE" - 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"` // Name: 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. // Only valid // when `client_id` is specified. Ignored otherwise. 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"` // StatusUpdateDeadlineSeconds: The number of seconds to wait for a // status update from the data source // before BigQuery marks the transfer as failed. StatusUpdateDeadlineSeconds int64 `json:"statusUpdateDeadlineSeconds,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: Indicates whether the data source supports // multiple transfers // to different BigQuery targets. SupportsMultipleTransfers bool `json:"supportsMultipleTransfers,omitempty"` // TransferType: Transfer type. Currently supports only batch // transfers, // which are transfers that use the BigQuery batch APIs (load or // query) to ingest the data. // // 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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AuthorizationType") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuthorizationType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*DataSource) MarshalJSON ¶
func (s *DataSource) MarshalJSON() ([]byte, error)
type DataSourceParameter ¶
DataSourceParameter: Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.
type DataSourceParameter struct { // AllowedValues: All possible values for the parameter. AllowedValues []string `json:"allowedValues,omitempty"` // Description: Parameter description. Description string `json:"description,omitempty"` // DisplayName: Parameter display name in the user interface. DisplayName string `json:"displayName,omitempty"` // Fields: When parameter is a record, describes child fields. Fields []*DataSourceParameter `json:"fields,omitempty"` // Immutable: Cannot be changed after initial creation. Immutable bool `json:"immutable,omitempty"` // MaxValue: For integer and double values specifies maxminum allowed // value. MaxValue float64 `json:"maxValue,omitempty"` // MinValue: For integer and double values specifies minimum allowed // value. MinValue float64 `json:"minValue,omitempty"` // ParamId: Parameter identifier. ParamId string `json:"paramId,omitempty"` // Recurse: If set to true, schema should be taken from the parent with // the same // parameter_id. Only applicable when parameter type is RECORD. Recurse bool `json:"recurse,omitempty"` // Repeated: Can parameter have multiple values. 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" - Record parameter. // "PLUS_PAGE" - Page ID for a Google+ Page. Type string `json:"type,omitempty"` // ValidationDescription: Description of the requirements for this // field, in case the user input does // not fulfill the regex pattern or min/max values. ValidationDescription string `json:"validationDescription,omitempty"` // ValidationHelpUrl: URL to a help document to further explain the // naming requirements. ValidationHelpUrl string `json:"validationHelpUrl,omitempty"` // ValidationRegex: Regular expression which can be used for parameter // validation. ValidationRegex string `json:"validationRegex,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowedValues") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllowedValues") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*DataSourceParameter) MarshalJSON ¶
func (s *DataSourceParameter) MarshalJSON() ([]byte, error)
func (*DataSourceParameter) UnmarshalJSON ¶
func (s *DataSourceParameter) UnmarshalJSON(data []byte) error
type Empty ¶
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
type IsEnabledRequest ¶
IsEnabledRequest: A request to determine whether data transfer is enabled for the project.
type IsEnabledRequest struct { }
type IsEnabledResponse ¶
IsEnabledResponse: A response to indicate whether data transfer is enabled for the project.
type IsEnabledResponse struct { // Enabled: Indicates whether the project is enabled. Enabled bool `json:"enabled,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Enabled") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Enabled") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*IsEnabledResponse) MarshalJSON ¶
func (s *IsEnabledResponse) MarshalJSON() ([]byte, error)
type ListDataSourcesResponse ¶
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: 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. // @OutputOnly NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DataSources") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSources") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ListDataSourcesResponse) MarshalJSON ¶
func (s *ListDataSourcesResponse) MarshalJSON() ([]byte, error)
type ListTransferConfigsResponse ¶
ListTransferConfigsResponse: The returned list of pipelines in the project.
type ListTransferConfigsResponse struct { // NextPageToken: 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. // @OutputOnly NextPageToken string `json:"nextPageToken,omitempty"` // TransferConfigs: The stored pipeline transfer // configurations. // @OutputOnly TransferConfigs []*TransferConfig `json:"transferConfigs,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ListTransferConfigsResponse) MarshalJSON ¶
func (s *ListTransferConfigsResponse) MarshalJSON() ([]byte, error)
type ListTransferLogsResponse ¶
ListTransferLogsResponse: The returned list transfer run messages.
type ListTransferLogsResponse struct { // NextPageToken: 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. // @OutputOnly NextPageToken string `json:"nextPageToken,omitempty"` // TransferMessages: The stored pipeline transfer messages. // @OutputOnly TransferMessages []*TransferMessage `json:"transferMessages,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ListTransferLogsResponse) MarshalJSON ¶
func (s *ListTransferLogsResponse) MarshalJSON() ([]byte, error)
type ListTransferRunsResponse ¶
ListTransferRunsResponse: The returned list of pipelines in the project.
type ListTransferRunsResponse struct { // NextPageToken: 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. // @OutputOnly NextPageToken string `json:"nextPageToken,omitempty"` // TransferRuns: The stored pipeline transfer runs. // @OutputOnly TransferRuns []*TransferRun `json:"transferRuns,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ListTransferRunsResponse) MarshalJSON ¶
func (s *ListTransferRunsResponse) MarshalJSON() ([]byte, error)
type ProjectsDataSourcesCheckValidCredsCall ¶
type ProjectsDataSourcesCheckValidCredsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDataSourcesCheckValidCredsCall) Context ¶
func (c *ProjectsDataSourcesCheckValidCredsCall) Context(ctx context.Context) *ProjectsDataSourcesCheckValidCredsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsDataSourcesCheckValidCredsCall) Do ¶
func (c *ProjectsDataSourcesCheckValidCredsCall) Do(opts ...googleapi.CallOption) (*CheckValidCredsResponse, error)
Do executes the "bigquerydatatransfer.projects.dataSources.checkValidCreds" call. Exactly one of *CheckValidCredsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CheckValidCredsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsDataSourcesCheckValidCredsCall) Fields ¶
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 information.
func (*ProjectsDataSourcesCheckValidCredsCall) Header ¶
func (c *ProjectsDataSourcesCheckValidCredsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsDataSourcesGetCall ¶
type ProjectsDataSourcesGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDataSourcesGetCall) Context ¶
func (c *ProjectsDataSourcesGetCall) Context(ctx context.Context) *ProjectsDataSourcesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsDataSourcesGetCall) Do ¶
func (c *ProjectsDataSourcesGetCall) Do(opts ...googleapi.CallOption) (*DataSource, error)
Do executes the "bigquerydatatransfer.projects.dataSources.get" call. Exactly one of *DataSource or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DataSource.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsDataSourcesGetCall) Fields ¶
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 information.
func (*ProjectsDataSourcesGetCall) Header ¶
func (c *ProjectsDataSourcesGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsDataSourcesGetCall) IfNoneMatch ¶
func (c *ProjectsDataSourcesGetCall) IfNoneMatch(entityTag string) *ProjectsDataSourcesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsDataSourcesListCall ¶
type ProjectsDataSourcesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDataSourcesListCall) Context ¶
func (c *ProjectsDataSourcesListCall) Context(ctx context.Context) *ProjectsDataSourcesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsDataSourcesListCall) Do ¶
func (c *ProjectsDataSourcesListCall) Do(opts ...googleapi.CallOption) (*ListDataSourcesResponse, error)
Do executes the "bigquerydatatransfer.projects.dataSources.list" call. Exactly one of *ListDataSourcesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDataSourcesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsDataSourcesListCall) Fields ¶
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 information.
func (*ProjectsDataSourcesListCall) Header ¶
func (c *ProjectsDataSourcesListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsDataSourcesListCall) IfNoneMatch ¶
func (c *ProjectsDataSourcesListCall) IfNoneMatch(entityTag string) *ProjectsDataSourcesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsDataSourcesListCall) PageSize ¶
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 (*ProjectsDataSourcesListCall) PageToken ¶
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 (*ProjectsDataSourcesListCall) Pages ¶
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 ¶
type ProjectsDataSourcesService struct {
// contains filtered or unexported fields
}
func NewProjectsDataSourcesService ¶
func NewProjectsDataSourcesService(s *Service) *ProjectsDataSourcesService
func (*ProjectsDataSourcesService) CheckValidCreds ¶
func (r *ProjectsDataSourcesService) CheckValidCreds(name string, checkvalidcredsrequest *CheckValidCredsRequest) *ProjectsDataSourcesCheckValidCredsCall
CheckValidCreds: Returns true if valid credentials exist for the given data source and requesting user.
func (*ProjectsDataSourcesService) Get ¶
func (r *ProjectsDataSourcesService) Get(name string) *ProjectsDataSourcesGetCall
Get: Retrieves a supported data source and returns its settings, which can be used for UI rendering.
func (*ProjectsDataSourcesService) List ¶
func (r *ProjectsDataSourcesService) List(parent string) *ProjectsDataSourcesListCall
List: Lists supported data sources and returns their settings, which can be used for UI rendering.
type ProjectsIsEnabledCall ¶
type ProjectsIsEnabledCall struct {
// contains filtered or unexported fields
}
func (*ProjectsIsEnabledCall) Context ¶
func (c *ProjectsIsEnabledCall) Context(ctx context.Context) *ProjectsIsEnabledCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsIsEnabledCall) Do ¶
func (c *ProjectsIsEnabledCall) Do(opts ...googleapi.CallOption) (*IsEnabledResponse, error)
Do executes the "bigquerydatatransfer.projects.isEnabled" call. Exactly one of *IsEnabledResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IsEnabledResponse.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 (*ProjectsIsEnabledCall) Fields ¶
func (c *ProjectsIsEnabledCall) Fields(s ...googleapi.Field) *ProjectsIsEnabledCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsIsEnabledCall) Header ¶
func (c *ProjectsIsEnabledCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsService ¶
type ProjectsService struct {
DataSources *ProjectsDataSourcesService
TransferConfigs *ProjectsTransferConfigsService
// contains filtered or unexported fields
}
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
func (*ProjectsService) IsEnabled ¶
func (r *ProjectsService) IsEnabled(name string, isenabledrequest *IsEnabledRequest) *ProjectsIsEnabledCall
IsEnabled: Returns true if data transfer is enabled for a project.
func (*ProjectsService) SetEnabled ¶
func (r *ProjectsService) SetEnabled(name string, setenabledrequest *SetEnabledRequest) *ProjectsSetEnabledCall
SetEnabled: Enables or disables data transfer for a project. This method requires the additional scope of 'https://www.googleapis.com/auth/cloudplatformprojects' to manage the cloud project permissions.
type ProjectsSetEnabledCall ¶
type ProjectsSetEnabledCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSetEnabledCall) Context ¶
func (c *ProjectsSetEnabledCall) Context(ctx context.Context) *ProjectsSetEnabledCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsSetEnabledCall) Do ¶
func (c *ProjectsSetEnabledCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.setEnabled" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsSetEnabledCall) Fields ¶
func (c *ProjectsSetEnabledCall) Fields(s ...googleapi.Field) *ProjectsSetEnabledCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSetEnabledCall) Header ¶
func (c *ProjectsSetEnabledCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTransferConfigsCreateCall ¶
type ProjectsTransferConfigsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsCreateCall) AuthorizationCode ¶
func (c *ProjectsTransferConfigsCreateCall) AuthorizationCode(authorizationCode string) *ProjectsTransferConfigsCreateCall
AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id= <datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<red irect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
* data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow
window.
Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text
prompting
the user to copy the code and paste it in the application.
func (*ProjectsTransferConfigsCreateCall) Context ¶
func (c *ProjectsTransferConfigsCreateCall) Context(ctx context.Context) *ProjectsTransferConfigsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsCreateCall) Do ¶
func (c *ProjectsTransferConfigsCreateCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.create" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsCreateCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsCreateCall) Header ¶
func (c *ProjectsTransferConfigsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTransferConfigsDeleteCall ¶
type ProjectsTransferConfigsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsDeleteCall) Context ¶
func (c *ProjectsTransferConfigsDeleteCall) Context(ctx context.Context) *ProjectsTransferConfigsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsDeleteCall) Do ¶
func (c *ProjectsTransferConfigsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsDeleteCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsDeleteCall) Header ¶
func (c *ProjectsTransferConfigsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTransferConfigsGetCall ¶
type ProjectsTransferConfigsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsGetCall) Context ¶
func (c *ProjectsTransferConfigsGetCall) Context(ctx context.Context) *ProjectsTransferConfigsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsGetCall) Do ¶
func (c *ProjectsTransferConfigsGetCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.get" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsGetCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsGetCall) Header ¶
func (c *ProjectsTransferConfigsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsGetCall) IfNoneMatch ¶
func (c *ProjectsTransferConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsTransferConfigsListCall ¶
type ProjectsTransferConfigsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsListCall) Context ¶
func (c *ProjectsTransferConfigsListCall) Context(ctx context.Context) *ProjectsTransferConfigsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsListCall) DataSourceIds ¶
func (c *ProjectsTransferConfigsListCall) DataSourceIds(dataSourceIds ...string) *ProjectsTransferConfigsListCall
DataSourceIds sets the optional parameter "dataSourceIds": When specified, only configurations of requested data sources are returned.
func (*ProjectsTransferConfigsListCall) Do ¶
func (c *ProjectsTransferConfigsListCall) Do(opts ...googleapi.CallOption) (*ListTransferConfigsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.list" call. Exactly one of *ListTransferConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsListCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsListCall) Header ¶
func (c *ProjectsTransferConfigsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsListCall) IfNoneMatch ¶
func (c *ProjectsTransferConfigsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsTransferConfigsListCall) PageSize ¶
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 (*ProjectsTransferConfigsListCall) PageToken ¶
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 (*ProjectsTransferConfigsListCall) Pages ¶
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 ¶
type ProjectsTransferConfigsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsPatchCall) AuthorizationCode ¶
func (c *ProjectsTransferConfigsPatchCall) AuthorizationCode(authorizationCode string) *ProjectsTransferConfigsPatchCall
AuthorizationCode sets the optional parameter "authorizationCode": Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the gaia id of the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id= <datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<red irect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
* data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow
window.
Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text
prompting
the user to copy the code and paste it in the application.
func (*ProjectsTransferConfigsPatchCall) Context ¶
func (c *ProjectsTransferConfigsPatchCall) Context(ctx context.Context) *ProjectsTransferConfigsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsPatchCall) Do ¶
func (c *ProjectsTransferConfigsPatchCall) Do(opts ...googleapi.CallOption) (*TransferConfig, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.patch" call. Exactly one of *TransferConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsPatchCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsPatchCall) Header ¶
func (c *ProjectsTransferConfigsPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsPatchCall) UpdateMask ¶
func (c *ProjectsTransferConfigsPatchCall) UpdateMask(updateMask string) *ProjectsTransferConfigsPatchCall
UpdateMask sets the optional parameter "updateMask": Required list of fields to be updated in this request.
type ProjectsTransferConfigsRunsDeleteCall ¶
type ProjectsTransferConfigsRunsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsRunsDeleteCall) Context ¶
func (c *ProjectsTransferConfigsRunsDeleteCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsRunsDeleteCall) Do ¶
func (c *ProjectsTransferConfigsRunsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsRunsDeleteCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsRunsDeleteCall) Header ¶
func (c *ProjectsTransferConfigsRunsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTransferConfigsRunsGetCall ¶
type ProjectsTransferConfigsRunsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsRunsGetCall) Context ¶
func (c *ProjectsTransferConfigsRunsGetCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsRunsGetCall) Do ¶
func (c *ProjectsTransferConfigsRunsGetCall) Do(opts ...googleapi.CallOption) (*TransferRun, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.get" call. Exactly one of *TransferRun or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsRunsGetCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsRunsGetCall) Header ¶
func (c *ProjectsTransferConfigsRunsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsRunsGetCall) IfNoneMatch ¶
func (c *ProjectsTransferConfigsRunsGetCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsTransferConfigsRunsListCall ¶
type ProjectsTransferConfigsRunsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsRunsListCall) Context ¶
func (c *ProjectsTransferConfigsRunsListCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsRunsListCall) Do ¶
func (c *ProjectsTransferConfigsRunsListCall) Do(opts ...googleapi.CallOption) (*ListTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.list" call. Exactly one of *ListTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferRunsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsRunsListCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsRunsListCall) Header ¶
func (c *ProjectsTransferConfigsRunsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsRunsListCall) IfNoneMatch ¶
func (c *ProjectsTransferConfigsRunsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsTransferConfigsRunsListCall) PageSize ¶
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 (*ProjectsTransferConfigsRunsListCall) PageToken ¶
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 (*ProjectsTransferConfigsRunsListCall) Pages ¶
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 (*ProjectsTransferConfigsRunsListCall) RunAttempt ¶
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" "LATEST"
func (*ProjectsTransferConfigsRunsListCall) Statuses ¶
func (c *ProjectsTransferConfigsRunsListCall) Statuses(statuses ...string) *ProjectsTransferConfigsRunsListCall
Statuses sets the optional parameter "statuses": When specified, only transfer runs with requested statuses are returned.
Possible values:
"TRANSFER_STATUS_UNSPECIFIED" "INACTIVE" "PENDING" "RUNNING" "SUCCEEDED" "FAILED" "CANCELLED"
type ProjectsTransferConfigsRunsService ¶
type ProjectsTransferConfigsRunsService struct {
TransferLogs *ProjectsTransferConfigsRunsTransferLogsService
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsRunsService ¶
func NewProjectsTransferConfigsRunsService(s *Service) *ProjectsTransferConfigsRunsService
func (*ProjectsTransferConfigsRunsService) Delete ¶
func (r *ProjectsTransferConfigsRunsService) Delete(name string) *ProjectsTransferConfigsRunsDeleteCall
Delete: Deletes the specified transfer run.
func (*ProjectsTransferConfigsRunsService) Get ¶
func (r *ProjectsTransferConfigsRunsService) Get(name string) *ProjectsTransferConfigsRunsGetCall
Get: Returns information about the particular transfer run.
func (*ProjectsTransferConfigsRunsService) List ¶
func (r *ProjectsTransferConfigsRunsService) List(parent string) *ProjectsTransferConfigsRunsListCall
List: Returns information about running and completed jobs.
type ProjectsTransferConfigsRunsTransferLogsListCall ¶
type ProjectsTransferConfigsRunsTransferLogsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsRunsTransferLogsListCall) Context ¶
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Context(ctx context.Context) *ProjectsTransferConfigsRunsTransferLogsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsRunsTransferLogsListCall) Do ¶
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Do(opts ...googleapi.CallOption) (*ListTransferLogsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list" call. Exactly one of *ListTransferLogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferLogsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsRunsTransferLogsListCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsRunsTransferLogsListCall) Header ¶
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTransferConfigsRunsTransferLogsListCall) IfNoneMatch ¶
func (c *ProjectsTransferConfigsRunsTransferLogsListCall) IfNoneMatch(entityTag string) *ProjectsTransferConfigsRunsTransferLogsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsTransferConfigsRunsTransferLogsListCall) MessageTypes ¶
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" "INFO" "WARNING" "ERROR"
func (*ProjectsTransferConfigsRunsTransferLogsListCall) PageSize ¶
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 (*ProjectsTransferConfigsRunsTransferLogsListCall) PageToken ¶
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 (*ProjectsTransferConfigsRunsTransferLogsListCall) Pages ¶
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 ¶
type ProjectsTransferConfigsRunsTransferLogsService struct {
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsRunsTransferLogsService ¶
func NewProjectsTransferConfigsRunsTransferLogsService(s *Service) *ProjectsTransferConfigsRunsTransferLogsService
func (*ProjectsTransferConfigsRunsTransferLogsService) List ¶
func (r *ProjectsTransferConfigsRunsTransferLogsService) List(parent string) *ProjectsTransferConfigsRunsTransferLogsListCall
List: Returns user facing log messages for the data transfer run.
type ProjectsTransferConfigsScheduleRunsCall ¶
type ProjectsTransferConfigsScheduleRunsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTransferConfigsScheduleRunsCall) Context ¶
func (c *ProjectsTransferConfigsScheduleRunsCall) Context(ctx context.Context) *ProjectsTransferConfigsScheduleRunsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTransferConfigsScheduleRunsCall) Do ¶
func (c *ProjectsTransferConfigsScheduleRunsCall) Do(opts ...googleapi.CallOption) (*ScheduleTransferRunsResponse, error)
Do executes the "bigquerydatatransfer.projects.transferConfigs.scheduleRuns" call. Exactly one of *ScheduleTransferRunsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ScheduleTransferRunsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTransferConfigsScheduleRunsCall) Fields ¶
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 information.
func (*ProjectsTransferConfigsScheduleRunsCall) Header ¶
func (c *ProjectsTransferConfigsScheduleRunsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTransferConfigsService ¶
type ProjectsTransferConfigsService struct {
Runs *ProjectsTransferConfigsRunsService
// contains filtered or unexported fields
}
func NewProjectsTransferConfigsService ¶
func NewProjectsTransferConfigsService(s *Service) *ProjectsTransferConfigsService
func (*ProjectsTransferConfigsService) Create ¶
func (r *ProjectsTransferConfigsService) Create(parent string, transferconfig *TransferConfig) *ProjectsTransferConfigsCreateCall
Create: Creates a new data transfer configuration.
func (*ProjectsTransferConfigsService) Delete ¶
func (r *ProjectsTransferConfigsService) Delete(name string) *ProjectsTransferConfigsDeleteCall
Delete: Deletes a data transfer configuration, including any associated transfer runs and logs.
func (*ProjectsTransferConfigsService) Get ¶
func (r *ProjectsTransferConfigsService) Get(name string) *ProjectsTransferConfigsGetCall
Get: Returns information about a data transfer config.
func (*ProjectsTransferConfigsService) List ¶
func (r *ProjectsTransferConfigsService) List(parent string) *ProjectsTransferConfigsListCall
List: Returns information about all data transfers in the project.
func (*ProjectsTransferConfigsService) Patch ¶
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 (*ProjectsTransferConfigsService) ScheduleRuns ¶
func (r *ProjectsTransferConfigsService) ScheduleRuns(parent string, scheduletransferrunsrequest *ScheduleTransferRunsRequest) *ProjectsTransferConfigsScheduleRunsCall
ScheduleRuns: Creates transfer runs for a time range [range_start_time, range_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.
type ScheduleTransferRunsRequest ¶
ScheduleTransferRunsRequest: A request to schedule transfer runs for a time range.
type ScheduleTransferRunsRequest struct { // RangeEndTime: End time of the range of transfer runs. RangeEndTime string `json:"rangeEndTime,omitempty"` // RangeStartTime: Start time of the range of transfer runs. RangeStartTime string `json:"rangeStartTime,omitempty"` // ForceSendFields is a list of field names (e.g. "RangeEndTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RangeEndTime") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ScheduleTransferRunsRequest) MarshalJSON ¶
func (s *ScheduleTransferRunsRequest) MarshalJSON() ([]byte, error)
type ScheduleTransferRunsResponse ¶
ScheduleTransferRunsResponse: A response to schedule transfer runs for a time range.
type ScheduleTransferRunsResponse struct { // CreatedRuns: The transfer runs that were created. CreatedRuns []*TransferRun `json:"createdRuns,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreatedRuns") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreatedRuns") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ScheduleTransferRunsResponse) MarshalJSON ¶
func (s *ScheduleTransferRunsResponse) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New ¶
func New(client *http.Client) (*Service, error)
type SetEnabledRequest ¶
SetEnabledRequest: A request to set whether data transfer is enabled or disabled for a project.
type SetEnabledRequest struct { // Enabled: Whether data transfer should be enabled or disabled for the // project. Enabled bool `json:"enabled,omitempty"` // ForceSendFields is a list of field names (e.g. "Enabled") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Enabled") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*SetEnabledRequest) MarshalJSON ¶
func (s *SetEnabledRequest) MarshalJSON() ([]byte, error)
type TransferConfig ¶
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. Cannot be changed once data transfer is // created. DataSourceId string `json:"dataSourceId,omitempty"` // DestinationDatasetId: The BigQuery target dataset id. DestinationDatasetId string `json:"destinationDatasetId,omitempty"` // Disabled: Is this config disabled. When set to true, no runs are // scheduled // for a given transfer. Disabled bool `json:"disabled,omitempty"` // DisplayName: User specified display name for the data transfer. DisplayName string `json:"displayName,omitempty"` // Name: The resource name of the transfer run. // Transfer run names have the // form // `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 // run. Name string `json:"name,omitempty"` // NextRunTime: Next time when data transfer will run. Output only. // Applicable // only for batch data transfers. // @OutputOnly NextRunTime string `json:"nextRunTime,omitempty"` // Params: Data transfer specific parameters. Params googleapi.RawMessage `json:"params,omitempty"` // Schedule: Data transfer schedule in GROC format. // 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 GROC include: // `1st,3rd monday of month 15:30`, // `every wed,fri of jan,jun 13:15`, and // `first sunday of quarter 00:00`. Schedule string `json:"schedule,omitempty"` // Status: Status of the most recently updated transfer run. // @OutputOnly // // Possible values: // "TRANSFER_STATUS_UNSPECIFIED" - Status placeholder. // "INACTIVE" - Data transfer is inactive. // "PENDING" - Data transfer is scheduled and is waiting to be picked // up by // data transfer backend. // "RUNNING" - Data transfer is in progress. // "SUCCEEDED" - Data transfer completed successsfully. // "FAILED" - Data transfer failed. // "CANCELLED" - Data transfer is cancelled. Status string `json:"status,omitempty"` // UpdateTime: Data transfer modification time. Ignored by server on // input. // @OutputOnly UpdateTime string `json:"updateTime,omitempty"` // UserId: GaiaID of the user on whose behalf transfer is done. // Applicable only // to data sources that do not support service accounts. When set to // 0, // the data source service account credentials are used. // @OutputOnly UserId int64 `json:"userId,omitempty,string"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "DataRefreshWindowDays") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataRefreshWindowDays") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*TransferConfig) MarshalJSON ¶
func (s *TransferConfig) MarshalJSON() ([]byte, error)
type TransferMessage ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MessageText") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TransferMessage) MarshalJSON ¶
func (s *TransferMessage) MarshalJSON() ([]byte, error)
type TransferRun ¶
TransferRun: Represents a data transfer run.
type TransferRun struct { // DataSourceId: Data source id. // @OutputOnly DataSourceId string `json:"dataSourceId,omitempty"` // DestinationDatasetId: The BigQuery target dataset id. DestinationDatasetId string `json:"destinationDatasetId,omitempty"` // EndTime: Time when transfer run ended. Parameter ignored by server // for input // requests. // @OutputOnly EndTime string `json:"endTime,omitempty"` // Name: The resource name of the transfer run. // Transfer run names have the // form // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` // . // The name is ignored when creating a transfer run. Name string `json:"name,omitempty"` // Params: Data transfer specific parameters. Params googleapi.RawMessage `json:"params,omitempty"` // RunTime: For batch transfer runs, specifies the date and time // that // data should be ingested. RunTime string `json:"runTime,omitempty"` // Schedule: Describes the schedule of this transfer run if it was // created as part of // a regular schedule. For batch transfer runs that are directly // created, // this is empty. // NOTE: the system might choose to delay the schedule depending on // the // current load, so `schedule_time` doesn't always matches // this. // @OutputOnly Schedule string `json:"schedule,omitempty"` // ScheduleTime: Minimum time after which a transfer run can be started. ScheduleTime string `json:"scheduleTime,omitempty"` // StartTime: Time when transfer run was started. Parameter ignored by // server for input // requests. // @OutputOnly StartTime string `json:"startTime,omitempty"` // Status: Data transfer run status. Ignored for input // requests. // @OutputOnly // // Possible values: // "TRANSFER_STATUS_UNSPECIFIED" - Status placeholder. // "INACTIVE" - Data transfer is inactive. // "PENDING" - Data transfer is scheduled and is waiting to be picked // up by // data transfer backend. // "RUNNING" - Data transfer is in progress. // "SUCCEEDED" - Data transfer completed successsfully. // "FAILED" - Data transfer failed. // "CANCELLED" - Data transfer is cancelled. Status string `json:"status,omitempty"` // UpdateTime: Last time the data transfer run status was // updated. // @OutputOnly UpdateTime string `json:"updateTime,omitempty"` // UserId: The user id for this transfer run. // @OutputOnly UserId int64 `json:"userId,omitempty,string"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DataSourceId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataSourceId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TransferRun) MarshalJSON ¶
func (s *TransferRun) MarshalJSON() ([]byte, error)