datatransfer

package
v0.0.0-...-96659ae Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2018 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package datatransfer is a generated protocol buffer package.

It is generated from these files: 

google/cloud/bigquery/datatransfer/v1/datatransfer.proto
google/cloud/bigquery/datatransfer/v1/transfer.proto

It has these top-level messages: 

DataSourceParameter
DataSource
GetDataSourceRequest
ListDataSourcesRequest
ListDataSourcesResponse
CreateTransferConfigRequest
UpdateTransferConfigRequest
GetTransferConfigRequest
DeleteTransferConfigRequest
GetTransferRunRequest
DeleteTransferRunRequest
ListTransferConfigsRequest
ListTransferConfigsResponse
ListTransferRunsRequest
ListTransferRunsResponse
ListTransferLogsRequest
ListTransferLogsResponse
CheckValidCredsRequest
CheckValidCredsResponse
ScheduleTransferRunsRequest
ScheduleTransferRunsResponse
TransferConfig
TransferRun
TransferMessage

Index

Constants

This section is empty.

Variables

View Source 
var DataSourceParameter_Type_name = map[int32]string{
	0: "TYPE_UNSPECIFIED",
	1: "STRING",
	2: "INTEGER",
	3: "DOUBLE",
	4: "BOOLEAN",
	5: "RECORD",
	6: "PLUS_PAGE",
}
View Source 
var DataSourceParameter_Type_value = map[string]int32{
	"TYPE_UNSPECIFIED": 0,
	"STRING":           1,
	"INTEGER":          2,
	"DOUBLE":           3,
	"BOOLEAN":          4,
	"RECORD":           5,
	"PLUS_PAGE":        6,
}
View Source 
var DataSource_AuthorizationType_name = map[int32]string{
	0: "AUTHORIZATION_TYPE_UNSPECIFIED",
	1: "AUTHORIZATION_CODE",
	2: "GOOGLE_PLUS_AUTHORIZATION_CODE",
}
View Source 
var DataSource_AuthorizationType_value = map[string]int32{
	"AUTHORIZATION_TYPE_UNSPECIFIED": 0,
	"AUTHORIZATION_CODE":             1,
	"GOOGLE_PLUS_AUTHORIZATION_CODE": 2,
}
View Source 
var DataSource_DataRefreshType_name = map[int32]string{
	0: "DATA_REFRESH_TYPE_UNSPECIFIED",
	1: "SLIDING_WINDOW",
	2: "CUSTOM_SLIDING_WINDOW",
}
View Source 
var DataSource_DataRefreshType_value = map[string]int32{
	"DATA_REFRESH_TYPE_UNSPECIFIED": 0,
	"SLIDING_WINDOW":                1,
	"CUSTOM_SLIDING_WINDOW":         2,
}
View Source 
var ListTransferRunsRequest_RunAttempt_name = map[int32]string{
	0: "RUN_ATTEMPT_UNSPECIFIED",
	1: "LATEST",
}
View Source 
var ListTransferRunsRequest_RunAttempt_value = map[string]int32{
	"RUN_ATTEMPT_UNSPECIFIED": 0,
	"LATEST":                  1,
}
View Source 
var TransferMessage_MessageSeverity_name = map[int32]string{
	0: "MESSAGE_SEVERITY_UNSPECIFIED",
	1: "INFO",
	2: "WARNING",
	3: "ERROR",
}
View Source 
var TransferMessage_MessageSeverity_value = map[string]int32{
	"MESSAGE_SEVERITY_UNSPECIFIED": 0,
	"INFO":                         1,
	"WARNING":                      2,
	"ERROR":                        3,
}
View Source 
var TransferState_name = map[int32]string{
	0: "TRANSFER_STATE_UNSPECIFIED",
	1: "INACTIVE",
	2: "PENDING",
	3: "RUNNING",
	4: "SUCCEEDED",
	5: "FAILED",
	6: "CANCELLED",
}
View Source 
var TransferState_value = map[string]int32{
	"TRANSFER_STATE_UNSPECIFIED": 0,
	"INACTIVE":                   1,
	"PENDING":                    2,
	"RUNNING":                    3,
	"SUCCEEDED":                  4,
	"FAILED":                     5,
	"CANCELLED":                  6,
}
View Source 
var TransferType_name = map[int32]string{
	0: "TRANSFER_TYPE_UNSPECIFIED",
	1: "BATCH",
	2: "STREAMING",
}
View Source 
var TransferType_value = map[string]int32{
	"TRANSFER_TYPE_UNSPECIFIED": 0,
	"BATCH":                     1,
	"STREAMING":                 2,
}

Functions

func RegisterDataTransferServiceServer 

func RegisterDataTransferServiceServer(s *grpc.Server, srv DataTransferServiceServer)

Types

type CheckValidCredsRequest 

type CheckValidCredsRequest struct {
	// The data source in the form:
	// `projects/{project_id}/dataSources/{data_source_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

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.

func (*CheckValidCredsRequest) Descriptor 

func (*CheckValidCredsRequest) Descriptor() ([]byte, []int)

func (*CheckValidCredsRequest) GetName 

func (m *CheckValidCredsRequest) GetName() string

func (*CheckValidCredsRequest) ProtoMessage 

func (*CheckValidCredsRequest) ProtoMessage()

func (*CheckValidCredsRequest) Reset 

func (m *CheckValidCredsRequest) Reset()

func (*CheckValidCredsRequest) String 

func (m *CheckValidCredsRequest) String() string

type CheckValidCredsResponse 

type CheckValidCredsResponse struct {
	// If set to `true`, the credentials exist and are valid.
	HasValidCreds bool `protobuf:"varint,1,opt,name=has_valid_creds,json=hasValidCreds" json:"has_valid_creds,omitempty"`
}

A response indicating whether the credentials exist and are valid.

func (*CheckValidCredsResponse) Descriptor 

func (*CheckValidCredsResponse) Descriptor() ([]byte, []int)

func (*CheckValidCredsResponse) GetHasValidCreds 

func (m *CheckValidCredsResponse) GetHasValidCreds() bool

func (*CheckValidCredsResponse) ProtoMessage 

func (*CheckValidCredsResponse) ProtoMessage()

func (*CheckValidCredsResponse) Reset 

func (m *CheckValidCredsResponse) Reset()

func (*CheckValidCredsResponse) String 

func (m *CheckValidCredsResponse) String() string

type CreateTransferConfigRequest 

type CreateTransferConfigRequest struct {
	// The BigQuery project id where the transfer configuration should be created.
	// Must be in the format /projects/{project_id}/locations/{location_id}
	// or
	// /projects/{project_id}/locations/-
	// In case when '-' is specified as location_id, location is infered from
	// the destination dataset region.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// Data transfer configuration to create.
	TransferConfig *TransferConfig `protobuf:"bytes,2,opt,name=transfer_config,json=transferConfig" json:"transfer_config,omitempty"`
	// 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=<redirect_uri>
	//
	// * client_id should be OAuth client_id of BigQuery DTS API for the given
	//   data source returned by ListDataSources method.
	// * data_source_scopes are the scopes returned by ListDataSources method.
	// * redirect_uri is an optional parameter. If not specified, then
	//   authorization code is posted to the opener of authorization flow window.
	//   Otherwise it will be sent to the redirect uri. A special value of
	//   urn:ietf:wg:oauth:2.0:oob means that authorization code should be
	//   returned in the title bar of the browser, with the page text prompting
	//   the user to copy the code and paste it in the application.
	AuthorizationCode string `protobuf:"bytes,3,opt,name=authorization_code,json=authorizationCode" json:"authorization_code,omitempty"`
}

A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. Otherwise, the transfer configuration will be associated with the calling user.

func (*CreateTransferConfigRequest) Descriptor 

func (*CreateTransferConfigRequest) Descriptor() ([]byte, []int)

func (*CreateTransferConfigRequest) GetAuthorizationCode 

func (m *CreateTransferConfigRequest) GetAuthorizationCode() string

func (*CreateTransferConfigRequest) GetParent 

func (m *CreateTransferConfigRequest) GetParent() string

func (*CreateTransferConfigRequest) GetTransferConfig 

func (m *CreateTransferConfigRequest) GetTransferConfig() *TransferConfig

func (*CreateTransferConfigRequest) ProtoMessage 

func (*CreateTransferConfigRequest) ProtoMessage()

func (*CreateTransferConfigRequest) Reset 

func (m *CreateTransferConfigRequest) Reset()

func (*CreateTransferConfigRequest) String 

func (m *CreateTransferConfigRequest) String() string

type DataSource 

type DataSource struct {
	// Data source resource name.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Data source id.
	DataSourceId string `protobuf:"bytes,2,opt,name=data_source_id,json=dataSourceId" json:"data_source_id,omitempty"`
	// User friendly data source name.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// User friendly data source description string.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// 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 `protobuf:"bytes,5,opt,name=client_id,json=clientId" json:"client_id,omitempty"`
	// 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 `protobuf:"bytes,6,rep,name=scopes" json:"scopes,omitempty"`
	// Transfer type. Currently supports only batch transfers,
	// which are transfers that use the BigQuery batch APIs (load or
	// query) to ingest the data.
	TransferType TransferType `` /* 147-byte string literal not displayed */
	// Indicates whether the data source supports multiple transfers
	// to different BigQuery targets.
	SupportsMultipleTransfers bool `` /* 132-byte string literal not displayed */
	// The number of seconds to wait for an update from the data source
	// before BigQuery marks the transfer as failed.
	UpdateDeadlineSeconds int32 `protobuf:"varint,9,opt,name=update_deadline_seconds,json=updateDeadlineSeconds" json:"update_deadline_seconds,omitempty"`
	// 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 `protobuf:"bytes,10,opt,name=default_schedule,json=defaultSchedule" json:"default_schedule,omitempty"`
	// 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 `protobuf:"varint,11,opt,name=supports_custom_schedule,json=supportsCustomSchedule" json:"supports_custom_schedule,omitempty"`
	// Data source parameters.
	Parameters []*DataSourceParameter `protobuf:"bytes,12,rep,name=parameters" json:"parameters,omitempty"`
	// Url for the help document for this data source.
	HelpUrl string `protobuf:"bytes,13,opt,name=help_url,json=helpUrl" json:"help_url,omitempty"`
	// Indicates the type of authorization.
	AuthorizationType DataSource_AuthorizationType `` /* 179-byte string literal not displayed */
	// 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.
	DataRefreshType DataSource_DataRefreshType `` /* 173-byte string literal not displayed */
	// Default data refresh window on days.
	// Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
	DefaultDataRefreshWindowDays int32 `` /* 146-byte string literal not displayed */
	// Disables backfilling and manual run scheduling
	// for the data source.
	ManualRunsDisabled bool `protobuf:"varint,17,opt,name=manual_runs_disabled,json=manualRunsDisabled" json:"manual_runs_disabled,omitempty"`
	// The minimum interval between two consecutive scheduled runs.
	MinimumScheduleInterval *google_protobuf4.Duration `` /* 126-byte string literal not displayed */
}

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

func (*DataSource) Descriptor 

func (*DataSource) Descriptor() ([]byte, []int)

func (*DataSource) GetAuthorizationType 

func (m *DataSource) GetAuthorizationType() DataSource_AuthorizationType

func (*DataSource) GetClientId 

func (m *DataSource) GetClientId() string

func (*DataSource) GetDataRefreshType 

func (m *DataSource) GetDataRefreshType() DataSource_DataRefreshType

func (*DataSource) GetDataSourceId 

func (m *DataSource) GetDataSourceId() string

func (*DataSource) GetDefaultDataRefreshWindowDays 

func (m *DataSource) GetDefaultDataRefreshWindowDays() int32

func (*DataSource) GetDefaultSchedule 

func (m *DataSource) GetDefaultSchedule() string

func (*DataSource) GetDescription 

func (m *DataSource) GetDescription() string

func (*DataSource) GetDisplayName 

func (m *DataSource) GetDisplayName() string

func (*DataSource) GetHelpUrl 

func (m *DataSource) GetHelpUrl() string

func (*DataSource) GetManualRunsDisabled 

func (m *DataSource) GetManualRunsDisabled() bool

func (*DataSource) GetMinimumScheduleInterval 

func (m *DataSource) GetMinimumScheduleInterval() *google_protobuf4.Duration

func (*DataSource) GetName 

func (m *DataSource) GetName() string

func (*DataSource) GetParameters 

func (m *DataSource) GetParameters() []*DataSourceParameter

func (*DataSource) GetScopes 

func (m *DataSource) GetScopes() []string

func (*DataSource) GetSupportsCustomSchedule 

func (m *DataSource) GetSupportsCustomSchedule() bool

func (*DataSource) GetSupportsMultipleTransfers 

func (m *DataSource) GetSupportsMultipleTransfers() bool

func (*DataSource) GetTransferType 

func (m *DataSource) GetTransferType() TransferType

func (*DataSource) GetUpdateDeadlineSeconds 

func (m *DataSource) GetUpdateDeadlineSeconds() int32

func (*DataSource) ProtoMessage 

func (*DataSource) ProtoMessage()

func (*DataSource) Reset 

func (m *DataSource) Reset()

func (*DataSource) String 

func (m *DataSource) String() string

type DataSourceParameter 

type DataSourceParameter struct {
	// Parameter identifier.
	ParamId string `protobuf:"bytes,1,opt,name=param_id,json=paramId" json:"param_id,omitempty"`
	// Parameter display name in the user interface.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// Parameter description.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// Parameter type.
	Type DataSourceParameter_Type `protobuf:"varint,4,opt,name=type,enum=google.cloud.bigquery.datatransfer.v1.DataSourceParameter_Type" json:"type,omitempty"`
	// Is parameter required.
	Required bool `protobuf:"varint,5,opt,name=required" json:"required,omitempty"`
	// Can parameter have multiple values.
	Repeated bool `protobuf:"varint,6,opt,name=repeated" json:"repeated,omitempty"`
	// Regular expression which can be used for parameter validation.
	ValidationRegex string `protobuf:"bytes,7,opt,name=validation_regex,json=validationRegex" json:"validation_regex,omitempty"`
	// All possible values for the parameter.
	AllowedValues []string `protobuf:"bytes,8,rep,name=allowed_values,json=allowedValues" json:"allowed_values,omitempty"`
	// For integer and double values specifies minimum allowed value.
	MinValue *google_protobuf7.DoubleValue `protobuf:"bytes,9,opt,name=min_value,json=minValue" json:"min_value,omitempty"`
	// For integer and double values specifies maxminum allowed value.
	MaxValue *google_protobuf7.DoubleValue `protobuf:"bytes,10,opt,name=max_value,json=maxValue" json:"max_value,omitempty"`
	// When parameter is a record, describes child fields.
	Fields []*DataSourceParameter `protobuf:"bytes,11,rep,name=fields" json:"fields,omitempty"`
	// Description of the requirements for this field, in case the user input does
	// not fulfill the regex pattern or min/max values.
	ValidationDescription string `protobuf:"bytes,12,opt,name=validation_description,json=validationDescription" json:"validation_description,omitempty"`
	// URL to a help document to further explain the naming requirements.
	ValidationHelpUrl string `protobuf:"bytes,13,opt,name=validation_help_url,json=validationHelpUrl" json:"validation_help_url,omitempty"`
	// Cannot be changed after initial creation.
	Immutable bool `protobuf:"varint,14,opt,name=immutable" json:"immutable,omitempty"`
	// 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 `protobuf:"varint,15,opt,name=recurse" json:"recurse,omitempty"`
}

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

func (*DataSourceParameter) Descriptor 

func (*DataSourceParameter) Descriptor() ([]byte, []int)

func (*DataSourceParameter) GetAllowedValues 

func (m *DataSourceParameter) GetAllowedValues() []string

func (*DataSourceParameter) GetDescription 

func (m *DataSourceParameter) GetDescription() string

func (*DataSourceParameter) GetDisplayName 

func (m *DataSourceParameter) GetDisplayName() string

func (*DataSourceParameter) GetFields 

func (m *DataSourceParameter) GetFields() []*DataSourceParameter

func (*DataSourceParameter) GetImmutable 

func (m *DataSourceParameter) GetImmutable() bool

func (*DataSourceParameter) GetMaxValue 

func (m *DataSourceParameter) GetMaxValue() *google_protobuf7.DoubleValue

func (*DataSourceParameter) GetMinValue 

func (m *DataSourceParameter) GetMinValue() *google_protobuf7.DoubleValue

func (*DataSourceParameter) GetParamId 

func (m *DataSourceParameter) GetParamId() string

func (*DataSourceParameter) GetRecurse 

func (m *DataSourceParameter) GetRecurse() bool

func (*DataSourceParameter) GetRepeated 

func (m *DataSourceParameter) GetRepeated() bool

func (*DataSourceParameter) GetRequired 

func (m *DataSourceParameter) GetRequired() bool

func (*DataSourceParameter) GetType 

func (m *DataSourceParameter) GetType() DataSourceParameter_Type

func (*DataSourceParameter) GetValidationDescription 

func (m *DataSourceParameter) GetValidationDescription() string

func (*DataSourceParameter) GetValidationHelpUrl 

func (m *DataSourceParameter) GetValidationHelpUrl() string

func (*DataSourceParameter) GetValidationRegex 

func (m *DataSourceParameter) GetValidationRegex() string

func (*DataSourceParameter) ProtoMessage 

func (*DataSourceParameter) ProtoMessage()

func (*DataSourceParameter) Reset 

func (m *DataSourceParameter) Reset()

func (*DataSourceParameter) String 

func (m *DataSourceParameter) String() string

type DataSourceParameter_Type 

type DataSourceParameter_Type int32

Parameter type. 

const (
	// Type unspecified.
	DataSourceParameter_TYPE_UNSPECIFIED DataSourceParameter_Type = 0
	// String parameter.
	DataSourceParameter_STRING DataSourceParameter_Type = 1
	// Integer parameter (64-bits).
	// Will be serialized to json as string.
	DataSourceParameter_INTEGER DataSourceParameter_Type = 2
	// Double precision floating point parameter.
	DataSourceParameter_DOUBLE DataSourceParameter_Type = 3
	// Boolean parameter.
	DataSourceParameter_BOOLEAN DataSourceParameter_Type = 4
	// Record parameter.
	DataSourceParameter_RECORD DataSourceParameter_Type = 5
	// Page ID for a Google+ Page.
	DataSourceParameter_PLUS_PAGE DataSourceParameter_Type = 6
)

func (DataSourceParameter_Type) EnumDescriptor 

func (DataSourceParameter_Type) EnumDescriptor() ([]byte, []int)

func (DataSourceParameter_Type) String 

func (x DataSourceParameter_Type) String() string

type DataSource_AuthorizationType 

type DataSource_AuthorizationType int32

The type of authorization needed for this data source. 

const (
	// Type unspecified.
	DataSource_AUTHORIZATION_TYPE_UNSPECIFIED DataSource_AuthorizationType = 0
	// Use OAuth 2 authorization codes that can be exchanged
	// for a refresh token on the backend.
	DataSource_AUTHORIZATION_CODE DataSource_AuthorizationType = 1
	// Return an authorization code for a given Google+ page that can then be
	// exchanged for a refresh token on the backend.
	DataSource_GOOGLE_PLUS_AUTHORIZATION_CODE DataSource_AuthorizationType = 2
)

func (DataSource_AuthorizationType) EnumDescriptor 

func (DataSource_AuthorizationType) EnumDescriptor() ([]byte, []int)

func (DataSource_AuthorizationType) String 

func (x DataSource_AuthorizationType) String() string

type DataSource_DataRefreshType 

type DataSource_DataRefreshType int32

Represents how the data source supports data auto refresh. 

const (
	// The data source won't support data auto refresh, which is default value.
	DataSource_DATA_REFRESH_TYPE_UNSPECIFIED DataSource_DataRefreshType = 0
	// 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.
	DataSource_SLIDING_WINDOW DataSource_DataRefreshType = 1
	// 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.
	DataSource_CUSTOM_SLIDING_WINDOW DataSource_DataRefreshType = 2
)

func (DataSource_DataRefreshType) EnumDescriptor 

func (DataSource_DataRefreshType) EnumDescriptor() ([]byte, []int)

func (DataSource_DataRefreshType) String 

func (x DataSource_DataRefreshType) String() string

type DataTransferServiceClient 

type DataTransferServiceClient interface {
	// Retrieves a supported data source and returns its settings,
	// which can be used for UI rendering.
	GetDataSource(ctx context.Context, in *GetDataSourceRequest, opts ...grpc.CallOption) (*DataSource, error)
	// Lists supported data sources and returns their settings,
	// which can be used for UI rendering.
	ListDataSources(ctx context.Context, in *ListDataSourcesRequest, opts ...grpc.CallOption) (*ListDataSourcesResponse, error)
	// Creates a new data transfer configuration.
	CreateTransferConfig(ctx context.Context, in *CreateTransferConfigRequest, opts ...grpc.CallOption) (*TransferConfig, error)
	// Updates a data transfer configuration.
	// All fields must be set, even if they are not updated.
	UpdateTransferConfig(ctx context.Context, in *UpdateTransferConfigRequest, opts ...grpc.CallOption) (*TransferConfig, error)
	// Deletes a data transfer configuration,
	// including any associated transfer runs and logs.
	DeleteTransferConfig(ctx context.Context, in *DeleteTransferConfigRequest, opts ...grpc.CallOption) (*google_protobuf5.Empty, error)
	// Returns information about a data transfer config.
	GetTransferConfig(ctx context.Context, in *GetTransferConfigRequest, opts ...grpc.CallOption) (*TransferConfig, error)
	// Returns information about all data transfers in the project.
	ListTransferConfigs(ctx context.Context, in *ListTransferConfigsRequest, opts ...grpc.CallOption) (*ListTransferConfigsResponse, error)
	// 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.
	ScheduleTransferRuns(ctx context.Context, in *ScheduleTransferRunsRequest, opts ...grpc.CallOption) (*ScheduleTransferRunsResponse, error)
	// Returns information about the particular transfer run.
	GetTransferRun(ctx context.Context, in *GetTransferRunRequest, opts ...grpc.CallOption) (*TransferRun, error)
	// Deletes the specified transfer run.
	DeleteTransferRun(ctx context.Context, in *DeleteTransferRunRequest, opts ...grpc.CallOption) (*google_protobuf5.Empty, error)
	// Returns information about running and completed jobs.
	ListTransferRuns(ctx context.Context, in *ListTransferRunsRequest, opts ...grpc.CallOption) (*ListTransferRunsResponse, error)
	// Returns user facing log messages for the data transfer run.
	ListTransferLogs(ctx context.Context, in *ListTransferLogsRequest, opts ...grpc.CallOption) (*ListTransferLogsResponse, error)
	// Returns true if valid credentials exist for the given data source and
	// requesting user.
	// Some data sources doesn't support service account, so we need to talk to
	// them on behalf of the end user. This API just checks whether we have OAuth
	// token for the particular user, which is a pre-requisite before user can
	// create a transfer config.
	CheckValidCreds(ctx context.Context, in *CheckValidCredsRequest, opts ...grpc.CallOption) (*CheckValidCredsResponse, error)
}

func NewDataTransferServiceClient 

func NewDataTransferServiceClient(cc *grpc.ClientConn) DataTransferServiceClient

type DataTransferServiceServer 

type DataTransferServiceServer interface {
	// Retrieves a supported data source and returns its settings,
	// which can be used for UI rendering.
	GetDataSource(context.Context, *GetDataSourceRequest) (*DataSource, error)
	// Lists supported data sources and returns their settings,
	// which can be used for UI rendering.
	ListDataSources(context.Context, *ListDataSourcesRequest) (*ListDataSourcesResponse, error)
	// Creates a new data transfer configuration.
	CreateTransferConfig(context.Context, *CreateTransferConfigRequest) (*TransferConfig, error)
	// Updates a data transfer configuration.
	// All fields must be set, even if they are not updated.
	UpdateTransferConfig(context.Context, *UpdateTransferConfigRequest) (*TransferConfig, error)
	// Deletes a data transfer configuration,
	// including any associated transfer runs and logs.
	DeleteTransferConfig(context.Context, *DeleteTransferConfigRequest) (*google_protobuf5.Empty, error)
	// Returns information about a data transfer config.
	GetTransferConfig(context.Context, *GetTransferConfigRequest) (*TransferConfig, error)
	// Returns information about all data transfers in the project.
	ListTransferConfigs(context.Context, *ListTransferConfigsRequest) (*ListTransferConfigsResponse, error)
	// 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.
	ScheduleTransferRuns(context.Context, *ScheduleTransferRunsRequest) (*ScheduleTransferRunsResponse, error)
	// Returns information about the particular transfer run.
	GetTransferRun(context.Context, *GetTransferRunRequest) (*TransferRun, error)
	// Deletes the specified transfer run.
	DeleteTransferRun(context.Context, *DeleteTransferRunRequest) (*google_protobuf5.Empty, error)
	// Returns information about running and completed jobs.
	ListTransferRuns(context.Context, *ListTransferRunsRequest) (*ListTransferRunsResponse, error)
	// Returns user facing log messages for the data transfer run.
	ListTransferLogs(context.Context, *ListTransferLogsRequest) (*ListTransferLogsResponse, error)
	// Returns true if valid credentials exist for the given data source and
	// requesting user.
	// Some data sources doesn't support service account, so we need to talk to
	// them on behalf of the end user. This API just checks whether we have OAuth
	// token for the particular user, which is a pre-requisite before user can
	// create a transfer config.
	CheckValidCreds(context.Context, *CheckValidCredsRequest) (*CheckValidCredsResponse, error)
}

type DeleteTransferConfigRequest 

type DeleteTransferConfigRequest struct {
	// The field will contain name of the resource requested, for example:
	// `projects/{project_id}/transferConfigs/{config_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.

func (*DeleteTransferConfigRequest) Descriptor 

func (*DeleteTransferConfigRequest) Descriptor() ([]byte, []int)

func (*DeleteTransferConfigRequest) GetName 

func (m *DeleteTransferConfigRequest) GetName() string

func (*DeleteTransferConfigRequest) ProtoMessage 

func (*DeleteTransferConfigRequest) ProtoMessage()

func (*DeleteTransferConfigRequest) Reset 

func (m *DeleteTransferConfigRequest) Reset()

func (*DeleteTransferConfigRequest) String 

func (m *DeleteTransferConfigRequest) String() string

type DeleteTransferRunRequest 

type DeleteTransferRunRequest struct {
	// The field will contain name of the resource requested, for example:
	// `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

A request to delete data transfer run information.

func (*DeleteTransferRunRequest) Descriptor 

func (*DeleteTransferRunRequest) Descriptor() ([]byte, []int)

func (*DeleteTransferRunRequest) GetName 

func (m *DeleteTransferRunRequest) GetName() string

func (*DeleteTransferRunRequest) ProtoMessage 

func (*DeleteTransferRunRequest) ProtoMessage()

func (*DeleteTransferRunRequest) Reset 

func (m *DeleteTransferRunRequest) Reset()

func (*DeleteTransferRunRequest) String 

func (m *DeleteTransferRunRequest) String() string

type GetDataSourceRequest 

type GetDataSourceRequest struct {
	// The field will contain name of the resource requested, for example:
	// `projects/{project_id}/dataSources/{data_source_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

A request to get data source info.

func (*GetDataSourceRequest) Descriptor 

func (*GetDataSourceRequest) Descriptor() ([]byte, []int)

func (*GetDataSourceRequest) GetName 

func (m *GetDataSourceRequest) GetName() string

func (*GetDataSourceRequest) ProtoMessage 

func (*GetDataSourceRequest) ProtoMessage()

func (*GetDataSourceRequest) Reset 

func (m *GetDataSourceRequest) Reset()

func (*GetDataSourceRequest) String 

func (m *GetDataSourceRequest) String() string

type GetTransferConfigRequest 

type GetTransferConfigRequest struct {
	// The field will contain name of the resource requested, for example:
	// `projects/{project_id}/transferConfigs/{config_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

A request to get data transfer information.

func (*GetTransferConfigRequest) Descriptor 

func (*GetTransferConfigRequest) Descriptor() ([]byte, []int)

func (*GetTransferConfigRequest) GetName 

func (m *GetTransferConfigRequest) GetName() string

func (*GetTransferConfigRequest) ProtoMessage 

func (*GetTransferConfigRequest) ProtoMessage()

func (*GetTransferConfigRequest) Reset 

func (m *GetTransferConfigRequest) Reset()

func (*GetTransferConfigRequest) String 

func (m *GetTransferConfigRequest) String() string

type GetTransferRunRequest 

type GetTransferRunRequest struct {
	// The field will contain name of the resource requested, for example:
	// `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

A request to get data transfer run information.

func (*GetTransferRunRequest) Descriptor 

func (*GetTransferRunRequest) Descriptor() ([]byte, []int)

func (*GetTransferRunRequest) GetName 

func (m *GetTransferRunRequest) GetName() string

func (*GetTransferRunRequest) ProtoMessage 

func (*GetTransferRunRequest) ProtoMessage()

func (*GetTransferRunRequest) Reset 

func (m *GetTransferRunRequest) Reset()

func (*GetTransferRunRequest) String 

func (m *GetTransferRunRequest) String() string

type ListDataSourcesRequest 

type ListDataSourcesRequest struct {
	// The BigQuery project id for which data sources should be returned.
	// Must be in the form: `projects/{project_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
	// Page size. The default page size is the maximum value of 1000 results.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
}

Request to list supported data sources and their data transfer settings.

func (*ListDataSourcesRequest) Descriptor 

func (*ListDataSourcesRequest) Descriptor() ([]byte, []int)

func (*ListDataSourcesRequest) GetPageSize 

func (m *ListDataSourcesRequest) GetPageSize() int32

func (*ListDataSourcesRequest) GetPageToken 

func (m *ListDataSourcesRequest) GetPageToken() string

func (*ListDataSourcesRequest) GetParent 

func (m *ListDataSourcesRequest) GetParent() string

func (*ListDataSourcesRequest) ProtoMessage 

func (*ListDataSourcesRequest) ProtoMessage()

func (*ListDataSourcesRequest) Reset 

func (m *ListDataSourcesRequest) Reset()

func (*ListDataSourcesRequest) String 

func (m *ListDataSourcesRequest) String() string

type ListDataSourcesResponse 

type ListDataSourcesResponse struct {
	// List of supported data sources and their transfer settings.
	DataSources []*DataSource `protobuf:"bytes,1,rep,name=data_sources,json=dataSources" json:"data_sources,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

Returns list of supported data sources and their metadata.

func (*ListDataSourcesResponse) Descriptor 

func (*ListDataSourcesResponse) Descriptor() ([]byte, []int)

func (*ListDataSourcesResponse) GetDataSources 

func (m *ListDataSourcesResponse) GetDataSources() []*DataSource

func (*ListDataSourcesResponse) GetNextPageToken 

func (m *ListDataSourcesResponse) GetNextPageToken() string

func (*ListDataSourcesResponse) ProtoMessage 

func (*ListDataSourcesResponse) ProtoMessage()

func (*ListDataSourcesResponse) Reset 

func (m *ListDataSourcesResponse) Reset()

func (*ListDataSourcesResponse) String 

func (m *ListDataSourcesResponse) String() string

type ListTransferConfigsRequest 

type ListTransferConfigsRequest struct {
	// The BigQuery project id for which data sources
	// should be returned: `projects/{project_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// When specified, only configurations of requested data sources are returned.
	DataSourceIds []string `protobuf:"bytes,2,rep,name=data_source_ids,json=dataSourceIds" json:"data_source_ids,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
	// Page size. The default page size is the maximum value of 1000 results.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
}

A request to list data transfers configured for a BigQuery project.

func (*ListTransferConfigsRequest) Descriptor 

func (*ListTransferConfigsRequest) Descriptor() ([]byte, []int)

func (*ListTransferConfigsRequest) GetDataSourceIds 

func (m *ListTransferConfigsRequest) GetDataSourceIds() []string

func (*ListTransferConfigsRequest) GetPageSize 

func (m *ListTransferConfigsRequest) GetPageSize() int32

func (*ListTransferConfigsRequest) GetPageToken 

func (m *ListTransferConfigsRequest) GetPageToken() string

func (*ListTransferConfigsRequest) GetParent 

func (m *ListTransferConfigsRequest) GetParent() string

func (*ListTransferConfigsRequest) ProtoMessage 

func (*ListTransferConfigsRequest) ProtoMessage()

func (*ListTransferConfigsRequest) Reset 

func (m *ListTransferConfigsRequest) Reset()

func (*ListTransferConfigsRequest) String 

func (m *ListTransferConfigsRequest) String() string

type ListTransferConfigsResponse 

type ListTransferConfigsResponse struct {
	// Output only. The stored pipeline transfer configurations.
	TransferConfigs []*TransferConfig `protobuf:"bytes,1,rep,name=transfer_configs,json=transferConfigs" json:"transfer_configs,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

The returned list of pipelines in the project.

func (*ListTransferConfigsResponse) Descriptor 

func (*ListTransferConfigsResponse) Descriptor() ([]byte, []int)

func (*ListTransferConfigsResponse) GetNextPageToken 

func (m *ListTransferConfigsResponse) GetNextPageToken() string

func (*ListTransferConfigsResponse) GetTransferConfigs 

func (m *ListTransferConfigsResponse) GetTransferConfigs() []*TransferConfig

func (*ListTransferConfigsResponse) ProtoMessage 

func (*ListTransferConfigsResponse) ProtoMessage()

func (*ListTransferConfigsResponse) Reset 

func (m *ListTransferConfigsResponse) Reset()

func (*ListTransferConfigsResponse) String 

func (m *ListTransferConfigsResponse) String() string

type ListTransferLogsRequest 

type ListTransferLogsRequest struct {
	// Transfer run name in the form:
	// `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
	// Page size. The default page size is the maximum value of 1000 results.
	PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// Message types to return. If not populated - INFO, WARNING and ERROR
	// messages are returned.
	MessageTypes []TransferMessage_MessageSeverity `` /* 173-byte string literal not displayed */
}

A request to get user facing log messages associated with data transfer run.

func (*ListTransferLogsRequest) Descriptor 

func (*ListTransferLogsRequest) Descriptor() ([]byte, []int)

func (*ListTransferLogsRequest) GetMessageTypes 

func (m *ListTransferLogsRequest) GetMessageTypes() []TransferMessage_MessageSeverity

func (*ListTransferLogsRequest) GetPageSize 

func (m *ListTransferLogsRequest) GetPageSize() int32

func (*ListTransferLogsRequest) GetPageToken 

func (m *ListTransferLogsRequest) GetPageToken() string

func (*ListTransferLogsRequest) GetParent 

func (m *ListTransferLogsRequest) GetParent() string

func (*ListTransferLogsRequest) ProtoMessage 

func (*ListTransferLogsRequest) ProtoMessage()

func (*ListTransferLogsRequest) Reset 

func (m *ListTransferLogsRequest) Reset()

func (*ListTransferLogsRequest) String 

func (m *ListTransferLogsRequest) String() string

type ListTransferLogsResponse 

type ListTransferLogsResponse struct {
	// Output only. The stored pipeline transfer messages.
	TransferMessages []*TransferMessage `protobuf:"bytes,1,rep,name=transfer_messages,json=transferMessages" json:"transfer_messages,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

The returned list transfer run messages.

func (*ListTransferLogsResponse) Descriptor 

func (*ListTransferLogsResponse) Descriptor() ([]byte, []int)

func (*ListTransferLogsResponse) GetNextPageToken 

func (m *ListTransferLogsResponse) GetNextPageToken() string

func (*ListTransferLogsResponse) GetTransferMessages 

func (m *ListTransferLogsResponse) GetTransferMessages() []*TransferMessage

func (*ListTransferLogsResponse) ProtoMessage 

func (*ListTransferLogsResponse) ProtoMessage()

func (*ListTransferLogsResponse) Reset 

func (m *ListTransferLogsResponse) Reset()

func (*ListTransferLogsResponse) String 

func (m *ListTransferLogsResponse) String() string

type ListTransferRunsRequest 

type ListTransferRunsRequest struct {
	// Name of transfer configuration for which transfer runs should be retrieved.
	// Format of transfer configuration resource name is:
	// `projects/{project_id}/transferConfigs/{config_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// When specified, only transfer runs with requested states are returned.
	States []TransferState `protobuf:"varint,2,rep,packed,name=states,enum=google.cloud.bigquery.datatransfer.v1.TransferState" json:"states,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
	// Page size. The default page size is the maximum value of 1000 results.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// Indicates how run attempts are to be pulled.
	RunAttempt ListTransferRunsRequest_RunAttempt `` /* 163-byte string literal not displayed */
}

A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled transfer runs.

func (*ListTransferRunsRequest) Descriptor 

func (*ListTransferRunsRequest) Descriptor() ([]byte, []int)

func (*ListTransferRunsRequest) GetPageSize 

func (m *ListTransferRunsRequest) GetPageSize() int32

func (*ListTransferRunsRequest) GetPageToken 

func (m *ListTransferRunsRequest) GetPageToken() string

func (*ListTransferRunsRequest) GetParent 

func (m *ListTransferRunsRequest) GetParent() string

func (*ListTransferRunsRequest) GetRunAttempt 

func (m *ListTransferRunsRequest) GetRunAttempt() ListTransferRunsRequest_RunAttempt

func (*ListTransferRunsRequest) GetStates 

func (m *ListTransferRunsRequest) GetStates() []TransferState

func (*ListTransferRunsRequest) ProtoMessage 

func (*ListTransferRunsRequest) ProtoMessage()

func (*ListTransferRunsRequest) Reset 

func (m *ListTransferRunsRequest) Reset()

func (*ListTransferRunsRequest) String 

func (m *ListTransferRunsRequest) String() string

type ListTransferRunsRequest_RunAttempt 

type ListTransferRunsRequest_RunAttempt int32

Represents which runs should be pulled. 

const (
	// All runs should be returned.
	ListTransferRunsRequest_RUN_ATTEMPT_UNSPECIFIED ListTransferRunsRequest_RunAttempt = 0
	// Only latest run per day should be returned.
	ListTransferRunsRequest_LATEST ListTransferRunsRequest_RunAttempt = 1
)

func (ListTransferRunsRequest_RunAttempt) EnumDescriptor 

func (ListTransferRunsRequest_RunAttempt) EnumDescriptor() ([]byte, []int)

func (ListTransferRunsRequest_RunAttempt) String 

func (x ListTransferRunsRequest_RunAttempt) String() string

type ListTransferRunsResponse 

type ListTransferRunsResponse struct {
	// Output only. The stored pipeline transfer runs.
	TransferRuns []*TransferRun `protobuf:"bytes,1,rep,name=transfer_runs,json=transferRuns" json:"transfer_runs,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

The returned list of pipelines in the project.

func (*ListTransferRunsResponse) Descriptor 

func (*ListTransferRunsResponse) Descriptor() ([]byte, []int)

func (*ListTransferRunsResponse) GetNextPageToken 

func (m *ListTransferRunsResponse) GetNextPageToken() string

func (*ListTransferRunsResponse) GetTransferRuns 

func (m *ListTransferRunsResponse) GetTransferRuns() []*TransferRun

func (*ListTransferRunsResponse) ProtoMessage 

func (*ListTransferRunsResponse) ProtoMessage()

func (*ListTransferRunsResponse) Reset 

func (m *ListTransferRunsResponse) Reset()

func (*ListTransferRunsResponse) String 

func (m *ListTransferRunsResponse) String() string

type ScheduleTransferRunsRequest 

type ScheduleTransferRunsRequest struct {
	// Transfer configuration name in the form:
	// `projects/{project_id}/transferConfigs/{config_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// Start time of the range of transfer runs. For example,
	// `"2017-05-25T00:00:00+00:00"`.
	StartTime *google_protobuf2.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	// End time of the range of transfer runs. For example,
	// `"2017-05-30T00:00:00+00:00"`.
	EndTime *google_protobuf2.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
}

A request to schedule transfer runs for a time range.

func (*ScheduleTransferRunsRequest) Descriptor 

func (*ScheduleTransferRunsRequest) Descriptor() ([]byte, []int)

func (*ScheduleTransferRunsRequest) GetEndTime 

func (m *ScheduleTransferRunsRequest) GetEndTime() *google_protobuf2.Timestamp

func (*ScheduleTransferRunsRequest) GetParent 

func (m *ScheduleTransferRunsRequest) GetParent() string

func (*ScheduleTransferRunsRequest) GetStartTime 

func (m *ScheduleTransferRunsRequest) GetStartTime() *google_protobuf2.Timestamp

func (*ScheduleTransferRunsRequest) ProtoMessage 

func (*ScheduleTransferRunsRequest) ProtoMessage()

func (*ScheduleTransferRunsRequest) Reset 

func (m *ScheduleTransferRunsRequest) Reset()

func (*ScheduleTransferRunsRequest) String 

func (m *ScheduleTransferRunsRequest) String() string

type ScheduleTransferRunsResponse 

type ScheduleTransferRunsResponse struct {
	// The transfer runs that were scheduled.
	Runs []*TransferRun `protobuf:"bytes,1,rep,name=runs" json:"runs,omitempty"`
}

A response to schedule transfer runs for a time range.

func (*ScheduleTransferRunsResponse) Descriptor 

func (*ScheduleTransferRunsResponse) Descriptor() ([]byte, []int)

func (*ScheduleTransferRunsResponse) GetRuns 

func (m *ScheduleTransferRunsResponse) GetRuns() []*TransferRun

func (*ScheduleTransferRunsResponse) ProtoMessage 

func (*ScheduleTransferRunsResponse) ProtoMessage()

func (*ScheduleTransferRunsResponse) Reset 

func (m *ScheduleTransferRunsResponse) Reset()

func (*ScheduleTransferRunsResponse) String 

func (m *ScheduleTransferRunsResponse) String() string

type TransferConfig 

type TransferConfig struct {
	// The resource name of the transfer config.
	// Transfer config 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
	// config.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The BigQuery target dataset id.
	DestinationDatasetId string `protobuf:"bytes,2,opt,name=destination_dataset_id,json=destinationDatasetId" json:"destination_dataset_id,omitempty"`
	// User specified display name for the data transfer.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// Data source id. Cannot be changed once data transfer is created.
	DataSourceId string `protobuf:"bytes,5,opt,name=data_source_id,json=dataSourceId" json:"data_source_id,omitempty"`
	// Data transfer specific parameters.
	Params *google_protobuf1.Struct `protobuf:"bytes,9,opt,name=params" json:"params,omitempty"`
	// Data transfer schedule.
	// If the data source does not support a custom schedule, this should be
	// empty. If it is empty, the default value for the data source will be
	// used.
	// The specified times are in UTC.
	// Examples of valid format:
	// `1st,3rd monday of month 15:30`,
	// `every wed,fri of jan,jun 13:15`, and
	// `first sunday of quarter 00:00`.
	// See more explanation about the format here:
	// https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
	// NOTE: the granularity should be at least 8 hours, or less frequent.
	Schedule string `protobuf:"bytes,7,opt,name=schedule" json:"schedule,omitempty"`
	// 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 int32 `protobuf:"varint,12,opt,name=data_refresh_window_days,json=dataRefreshWindowDays" json:"data_refresh_window_days,omitempty"`
	// Is this config disabled. When set to true, no runs are scheduled
	// for a given transfer.
	Disabled bool `protobuf:"varint,13,opt,name=disabled" json:"disabled,omitempty"`
	// Output only. Data transfer modification time. Ignored by server on input.
	UpdateTime *google_protobuf2.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
	// Output only. Next time when data transfer will run.
	NextRunTime *google_protobuf2.Timestamp `protobuf:"bytes,8,opt,name=next_run_time,json=nextRunTime" json:"next_run_time,omitempty"`
	// Output only. State of the most recently updated transfer run.
	State TransferState `protobuf:"varint,10,opt,name=state,enum=google.cloud.bigquery.datatransfer.v1.TransferState" json:"state,omitempty"`
	// Output only. Unique ID 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.
	UserId int64 `protobuf:"varint,11,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// Output only. Region in which BigQuery dataset is located.
	DatasetRegion string `protobuf:"bytes,14,opt,name=dataset_region,json=datasetRegion" json:"dataset_region,omitempty"`
}

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

func (*TransferConfig) Descriptor 

func (*TransferConfig) Descriptor() ([]byte, []int)

func (*TransferConfig) GetDataRefreshWindowDays 

func (m *TransferConfig) GetDataRefreshWindowDays() int32

func (*TransferConfig) GetDataSourceId 

func (m *TransferConfig) GetDataSourceId() string

func (*TransferConfig) GetDatasetRegion 

func (m *TransferConfig) GetDatasetRegion() string

func (*TransferConfig) GetDestinationDatasetId 

func (m *TransferConfig) GetDestinationDatasetId() string

func (*TransferConfig) GetDisabled 

func (m *TransferConfig) GetDisabled() bool

func (*TransferConfig) GetDisplayName 

func (m *TransferConfig) GetDisplayName() string

func (*TransferConfig) GetName 

func (m *TransferConfig) GetName() string

func (*TransferConfig) GetNextRunTime 

func (m *TransferConfig) GetNextRunTime() *google_protobuf2.Timestamp

func (*TransferConfig) GetParams 

func (m *TransferConfig) GetParams() *google_protobuf1.Struct

func (*TransferConfig) GetSchedule 

func (m *TransferConfig) GetSchedule() string

func (*TransferConfig) GetState 

func (m *TransferConfig) GetState() TransferState

func (*TransferConfig) GetUpdateTime 

func (m *TransferConfig) GetUpdateTime() *google_protobuf2.Timestamp

func (*TransferConfig) GetUserId 

func (m *TransferConfig) GetUserId() int64

func (*TransferConfig) ProtoMessage 

func (*TransferConfig) ProtoMessage()

func (*TransferConfig) Reset 

func (m *TransferConfig) Reset()

func (*TransferConfig) String 

func (m *TransferConfig) String() string

type TransferMessage 

type TransferMessage struct {
	// Time when message was logged.
	MessageTime *google_protobuf2.Timestamp `protobuf:"bytes,1,opt,name=message_time,json=messageTime" json:"message_time,omitempty"`
	// Message severity.
	Severity TransferMessage_MessageSeverity `` /* 138-byte string literal not displayed */
	// Message text.
	MessageText string `protobuf:"bytes,3,opt,name=message_text,json=messageText" json:"message_text,omitempty"`
}

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

func (*TransferMessage) Descriptor 

func (*TransferMessage) Descriptor() ([]byte, []int)

func (*TransferMessage) GetMessageText 

func (m *TransferMessage) GetMessageText() string

func (*TransferMessage) GetMessageTime 

func (m *TransferMessage) GetMessageTime() *google_protobuf2.Timestamp

func (*TransferMessage) GetSeverity 

func (m *TransferMessage) GetSeverity() TransferMessage_MessageSeverity

func (*TransferMessage) ProtoMessage 

func (*TransferMessage) ProtoMessage()

func (*TransferMessage) Reset 

func (m *TransferMessage) Reset()

func (*TransferMessage) String 

func (m *TransferMessage) String() string

type TransferMessage_MessageSeverity 

type TransferMessage_MessageSeverity int32

Represents data transfer user facing message severity. 

const (
	// No severity specified.
	TransferMessage_MESSAGE_SEVERITY_UNSPECIFIED TransferMessage_MessageSeverity = 0
	// Informational message.
	TransferMessage_INFO TransferMessage_MessageSeverity = 1
	// Warning message.
	TransferMessage_WARNING TransferMessage_MessageSeverity = 2
	// Error message.
	TransferMessage_ERROR TransferMessage_MessageSeverity = 3
)

func (TransferMessage_MessageSeverity) EnumDescriptor 

func (TransferMessage_MessageSeverity) EnumDescriptor() ([]byte, []int)

func (TransferMessage_MessageSeverity) String 

func (x TransferMessage_MessageSeverity) String() string

type TransferRun 

type TransferRun struct {
	// 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 `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The BigQuery target dataset id.
	DestinationDatasetId string `protobuf:"bytes,2,opt,name=destination_dataset_id,json=destinationDatasetId" json:"destination_dataset_id,omitempty"`
	// Minimum time after which a transfer run can be started.
	ScheduleTime *google_protobuf2.Timestamp `protobuf:"bytes,3,opt,name=schedule_time,json=scheduleTime" json:"schedule_time,omitempty"`
	// Data transfer specific parameters.
	Params *google_protobuf1.Struct `protobuf:"bytes,9,opt,name=params" json:"params,omitempty"`
	// For batch transfer runs, specifies the date and time that
	// data should be ingested.
	RunTime *google_protobuf2.Timestamp `protobuf:"bytes,10,opt,name=run_time,json=runTime" json:"run_time,omitempty"`
	// Output only. Time when transfer run was started.
	// Parameter ignored by server for input requests.
	StartTime *google_protobuf2.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	// Output only. Time when transfer run ended.
	// Parameter ignored by server for input requests.
	EndTime *google_protobuf2.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
	// Output only. Last time the data transfer run state was updated.
	UpdateTime *google_protobuf2.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
	// Output only. Data source id.
	DataSourceId string `protobuf:"bytes,7,opt,name=data_source_id,json=dataSourceId" json:"data_source_id,omitempty"`
	// Data transfer run state. Ignored for input requests.
	State TransferState `protobuf:"varint,8,opt,name=state,enum=google.cloud.bigquery.datatransfer.v1.TransferState" json:"state,omitempty"`
	// Output only. Unique ID 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.
	// May be negative.
	UserId int64 `protobuf:"varint,11,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// 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 matches this.
	Schedule string `protobuf:"bytes,12,opt,name=schedule" json:"schedule,omitempty"`
}

Represents a data transfer run. Next id: 23

func (*TransferRun) Descriptor 

func (*TransferRun) Descriptor() ([]byte, []int)

func (*TransferRun) GetDataSourceId 

func (m *TransferRun) GetDataSourceId() string

func (*TransferRun) GetDestinationDatasetId 

func (m *TransferRun) GetDestinationDatasetId() string

func (*TransferRun) GetEndTime 

func (m *TransferRun) GetEndTime() *google_protobuf2.Timestamp

func (*TransferRun) GetName 

func (m *TransferRun) GetName() string

func (*TransferRun) GetParams 

func (m *TransferRun) GetParams() *google_protobuf1.Struct

func (*TransferRun) GetRunTime 

func (m *TransferRun) GetRunTime() *google_protobuf2.Timestamp

func (*TransferRun) GetSchedule 

func (m *TransferRun) GetSchedule() string

func (*TransferRun) GetScheduleTime 

func (m *TransferRun) GetScheduleTime() *google_protobuf2.Timestamp

func (*TransferRun) GetStartTime 

func (m *TransferRun) GetStartTime() *google_protobuf2.Timestamp

func (*TransferRun) GetState 

func (m *TransferRun) GetState() TransferState

func (*TransferRun) GetUpdateTime 

func (m *TransferRun) GetUpdateTime() *google_protobuf2.Timestamp

func (*TransferRun) GetUserId 

func (m *TransferRun) GetUserId() int64

func (*TransferRun) ProtoMessage 

func (*TransferRun) ProtoMessage()

func (*TransferRun) Reset 

func (m *TransferRun) Reset()

func (*TransferRun) String 

func (m *TransferRun) String() string

type TransferState 

type TransferState int32

Represents data transfer run state. 

const (
	// State placeholder.
	TransferState_TRANSFER_STATE_UNSPECIFIED TransferState = 0
	// Data transfer is inactive.
	TransferState_INACTIVE TransferState = 1
	// Data transfer is scheduled and is waiting to be picked up by
	// data transfer backend.
	TransferState_PENDING TransferState = 2
	// Data transfer is in progress.
	TransferState_RUNNING TransferState = 3
	// Data transfer completed successsfully.
	TransferState_SUCCEEDED TransferState = 4
	// Data transfer failed.
	TransferState_FAILED TransferState = 5
	// Data transfer is cancelled.
	TransferState_CANCELLED TransferState = 6
)

func (TransferState) EnumDescriptor 

func (TransferState) EnumDescriptor() ([]byte, []int)

func (TransferState) String 

func (x TransferState) String() string

type TransferType 

type TransferType int32

Represents data transfer type. 

const (
	// Invalid or Unknown transfer type placeholder.
	TransferType_TRANSFER_TYPE_UNSPECIFIED TransferType = 0
	// Batch data transfer.
	TransferType_BATCH TransferType = 1
	// Streaming data transfer. Streaming data source currently doesn't
	// support multiple transfer configs per project.
	TransferType_STREAMING TransferType = 2
)

func (TransferType) EnumDescriptor 

func (TransferType) EnumDescriptor() ([]byte, []int)

func (TransferType) String 

func (x TransferType) String() string

type UpdateTransferConfigRequest 

type UpdateTransferConfigRequest struct {
	// Data transfer configuration to create.
	TransferConfig *TransferConfig `protobuf:"bytes,1,opt,name=transfer_config,json=transferConfig" json:"transfer_config,omitempty"`
	// Optional OAuth2 authorization code to use with this transfer configuration.
	// If it is provided, the transfer configuration will be associated with the
	// authorizing user.
	// In order to obtain authorization_code, please make a
	// request to
	// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
	//
	// * client_id should be OAuth client_id of BigQuery DTS API for the given
	//   data source returned by ListDataSources method.
	// * data_source_scopes are the scopes returned by ListDataSources method.
	// * redirect_uri is an optional parameter. If not specified, then
	//   authorization code is posted to the opener of authorization flow window.
	//   Otherwise it will be sent to the redirect uri. A special value of
	//   urn:ietf:wg:oauth:2.0:oob means that authorization code should be
	//   returned in the title bar of the browser, with the page text prompting
	//   the user to copy the code and paste it in the application.
	AuthorizationCode string `protobuf:"bytes,3,opt,name=authorization_code,json=authorizationCode" json:"authorization_code,omitempty"`
	// Required list of fields to be updated in this request.
	UpdateMask *google_protobuf6.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
}

A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.

func (*UpdateTransferConfigRequest) Descriptor 

func (*UpdateTransferConfigRequest) Descriptor() ([]byte, []int)

func (*UpdateTransferConfigRequest) GetAuthorizationCode 

func (m *UpdateTransferConfigRequest) GetAuthorizationCode() string

func (*UpdateTransferConfigRequest) GetTransferConfig 

func (m *UpdateTransferConfigRequest) GetTransferConfig() *TransferConfig

func (*UpdateTransferConfigRequest) GetUpdateMask 

func (m *UpdateTransferConfigRequest) GetUpdateMask() *google_protobuf6.FieldMask

func (*UpdateTransferConfigRequest) ProtoMessage 

func (*UpdateTransferConfigRequest) ProtoMessage()

func (*UpdateTransferConfigRequest) Reset 

func (m *UpdateTransferConfigRequest) Reset()

func (*UpdateTransferConfigRequest) String 

func (m *UpdateTransferConfigRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.