datatransferpb

package
v1.51.2 Latest Latest
Warning

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

Go to latest
Published: May 9, 2023 License: Apache-2.0 Imports: 16 Imported by: 1

Documentation

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",
	}
	DataSourceParameter_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"STRING":           1,
		"INTEGER":          2,
		"DOUBLE":           3,
		"BOOLEAN":          4,
		"RECORD":           5,
		"PLUS_PAGE":        6,
	}
)

Enum value maps for DataSourceParameter_Type.

View Source
var (
	DataSource_AuthorizationType_name = map[int32]string{
		0: "AUTHORIZATION_TYPE_UNSPECIFIED",
		1: "AUTHORIZATION_CODE",
		2: "GOOGLE_PLUS_AUTHORIZATION_CODE",
		3: "FIRST_PARTY_OAUTH",
	}
	DataSource_AuthorizationType_value = map[string]int32{
		"AUTHORIZATION_TYPE_UNSPECIFIED": 0,
		"AUTHORIZATION_CODE":             1,
		"GOOGLE_PLUS_AUTHORIZATION_CODE": 2,
		"FIRST_PARTY_OAUTH":              3,
	}
)

Enum value maps for DataSource_AuthorizationType.

View Source
var (
	DataSource_DataRefreshType_name = map[int32]string{
		0: "DATA_REFRESH_TYPE_UNSPECIFIED",
		1: "SLIDING_WINDOW",
		2: "CUSTOM_SLIDING_WINDOW",
	}
	DataSource_DataRefreshType_value = map[string]int32{
		"DATA_REFRESH_TYPE_UNSPECIFIED": 0,
		"SLIDING_WINDOW":                1,
		"CUSTOM_SLIDING_WINDOW":         2,
	}
)

Enum value maps for DataSource_DataRefreshType.

View Source
var (
	ListTransferRunsRequest_RunAttempt_name = map[int32]string{
		0: "RUN_ATTEMPT_UNSPECIFIED",
		1: "LATEST",
	}
	ListTransferRunsRequest_RunAttempt_value = map[string]int32{
		"RUN_ATTEMPT_UNSPECIFIED": 0,
		"LATEST":                  1,
	}
)

Enum value maps for ListTransferRunsRequest_RunAttempt.

View Source
var (
	TransferType_name = map[int32]string{
		0: "TRANSFER_TYPE_UNSPECIFIED",
		1: "BATCH",
		2: "STREAMING",
	}
	TransferType_value = map[string]int32{
		"TRANSFER_TYPE_UNSPECIFIED": 0,
		"BATCH":                     1,
		"STREAMING":                 2,
	}
)

Enum value maps for TransferType.

View Source
var (
	TransferState_name = map[int32]string{
		0: "TRANSFER_STATE_UNSPECIFIED",
		2: "PENDING",
		3: "RUNNING",
		4: "SUCCEEDED",
		5: "FAILED",
		6: "CANCELLED",
	}
	TransferState_value = map[string]int32{
		"TRANSFER_STATE_UNSPECIFIED": 0,
		"PENDING":                    2,
		"RUNNING":                    3,
		"SUCCEEDED":                  4,
		"FAILED":                     5,
		"CANCELLED":                  6,
	}
)

Enum value maps for TransferState.

View Source
var (
	TransferMessage_MessageSeverity_name = map[int32]string{
		0: "MESSAGE_SEVERITY_UNSPECIFIED",
		1: "INFO",
		2: "WARNING",
		3: "ERROR",
	}
	TransferMessage_MessageSeverity_value = map[string]int32{
		"MESSAGE_SEVERITY_UNSPECIFIED": 0,
		"INFO":                         1,
		"WARNING":                      2,
		"ERROR":                        3,
	}
)

Enum value maps for TransferMessage_MessageSeverity.

View Source
var File_google_cloud_bigquery_datatransfer_v1_datatransfer_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_bigquery_datatransfer_v1_transfer_proto protoreflect.FileDescriptor

Functions

func RegisterDataTransferServiceServer

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

Types

type CheckValidCredsRequest

type CheckValidCredsRequest struct {

	// Required. The data source in the form:
	// `projects/{project_id}/dataSources/{data_source_id}` or
	// `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated

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

Deprecated: Use CheckValidCredsRequest.ProtoReflect.Descriptor instead.

func (*CheckValidCredsRequest) GetName

func (x *CheckValidCredsRequest) GetName() string

func (*CheckValidCredsRequest) ProtoMessage

func (*CheckValidCredsRequest) ProtoMessage()

func (*CheckValidCredsRequest) ProtoReflect

func (x *CheckValidCredsRequest) ProtoReflect() protoreflect.Message

func (*CheckValidCredsRequest) Reset

func (x *CheckValidCredsRequest) Reset()

func (*CheckValidCredsRequest) String

func (x *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,proto3" json:"has_valid_creds,omitempty"`
	// contains filtered or unexported fields
}

A response indicating whether the credentials exist and are valid.

func (*CheckValidCredsResponse) Descriptor deprecated

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

Deprecated: Use CheckValidCredsResponse.ProtoReflect.Descriptor instead.

func (*CheckValidCredsResponse) GetHasValidCreds

func (x *CheckValidCredsResponse) GetHasValidCreds() bool

func (*CheckValidCredsResponse) ProtoMessage

func (*CheckValidCredsResponse) ProtoMessage()

func (*CheckValidCredsResponse) ProtoReflect

func (x *CheckValidCredsResponse) ProtoReflect() protoreflect.Message

func (*CheckValidCredsResponse) Reset

func (x *CheckValidCredsResponse) Reset()

func (*CheckValidCredsResponse) String

func (x *CheckValidCredsResponse) String() string

type CreateTransferConfigRequest

type CreateTransferConfigRequest struct {

	// Required. 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}. If
	// specified location and location of the destination bigquery dataset do not
	// match - the request will fail.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Data transfer configuration to create.
	TransferConfig *TransferConfig `protobuf:"bytes,2,opt,name=transfer_config,json=transferConfig,proto3" json:"transfer_config,omitempty"`
	// Optional OAuth2 authorization code to use with this transfer configuration.
	// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
	// and new credentials are needed, as indicated by `CheckValidCreds`. In order
	// to obtain authorization_code, make a request to the following URL:
	// <pre class="prettyprint" suppresswarning="true">
	// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
	// </pre>
	// * The <var>client_id</var> is the OAuth client_id of the a data source as
	// returned by ListDataSources method.
	// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
	// method.
	//
	// Note that this should not be set when `service_account_name` is used to
	// create the transfer config.
	AuthorizationCode string `protobuf:"bytes,3,opt,name=authorization_code,json=authorizationCode,proto3" json:"authorization_code,omitempty"`
	// Optional version info. This is required only if
	// `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
	// are needed, as indicated by `CheckValidCreds`. In order to obtain version
	// info, make a request to the following URL:
	// <pre class="prettyprint" suppresswarning="true">
	// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
	// </pre>
	// * The <var>client_id</var> is the OAuth client_id of the a data source as
	// returned by ListDataSources method.
	// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
	// method.
	//
	// Note that this should not be set when `service_account_name` is used to
	// create the transfer config.
	VersionInfo string `protobuf:"bytes,5,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// Optional service account email. If this field is set, the transfer config
	// will be created with this service account's credentials. It requires that
	// the requesting user calling this API has permissions to act as this service
	// account.
	//
	// Note that not all data sources support service account credentials when
	// creating a transfer config. For the latest list of data sources, read about
	// [using service
	// accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
	ServiceAccountName string `protobuf:"bytes,6,opt,name=service_account_name,json=serviceAccountName,proto3" json:"service_account_name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateTransferConfigRequest) Descriptor deprecated

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

Deprecated: Use CreateTransferConfigRequest.ProtoReflect.Descriptor instead.

func (*CreateTransferConfigRequest) GetAuthorizationCode

func (x *CreateTransferConfigRequest) GetAuthorizationCode() string

func (*CreateTransferConfigRequest) GetParent

func (x *CreateTransferConfigRequest) GetParent() string

func (*CreateTransferConfigRequest) GetServiceAccountName

func (x *CreateTransferConfigRequest) GetServiceAccountName() string

func (*CreateTransferConfigRequest) GetTransferConfig

func (x *CreateTransferConfigRequest) GetTransferConfig() *TransferConfig

func (*CreateTransferConfigRequest) GetVersionInfo

func (x *CreateTransferConfigRequest) GetVersionInfo() string

func (*CreateTransferConfigRequest) ProtoMessage

func (*CreateTransferConfigRequest) ProtoMessage()

func (*CreateTransferConfigRequest) ProtoReflect

func (*CreateTransferConfigRequest) Reset

func (x *CreateTransferConfigRequest) Reset()

func (*CreateTransferConfigRequest) String

func (x *CreateTransferConfigRequest) String() string

type DataSource

type DataSource struct {

	// Output only. Data source resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Data source id.
	DataSourceId string `protobuf:"bytes,2,opt,name=data_source_id,json=dataSourceId,proto3" json:"data_source_id,omitempty"`
	// User friendly data source name.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// User friendly data source description string.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Data source client id which should be used to receive refresh token.
	ClientId string `protobuf:"bytes,5,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Api auth scopes for which refresh token needs to be obtained. These are
	// scopes needed by a data source to prepare data and ingest them into
	// BigQuery, e.g., https://www.googleapis.com/auth/bigquery
	Scopes []string `protobuf:"bytes,6,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// Deprecated. This field has no effect.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
	TransferType TransferType `` /* 154-byte string literal not displayed */
	// Deprecated. This field has no effect.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
	SupportsMultipleTransfers bool `` /* 139-byte string literal not displayed */
	// The number of seconds to wait for an update from the data source
	// before the Data Transfer Service marks the transfer as FAILED.
	UpdateDeadlineSeconds int32 `` /* 127-byte string literal not displayed */
	// 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,proto3" 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 `` /* 131-byte string literal not displayed */
	// Data source parameters.
	Parameters []*DataSourceParameter `protobuf:"bytes,12,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// Url for the help document for this data source.
	HelpUrl string `protobuf:"bytes,13,opt,name=help_url,json=helpUrl,proto3" json:"help_url,omitempty"`
	// Indicates the type of authorization.
	AuthorizationType DataSource_AuthorizationType `` /* 186-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 `` /* 180-byte string literal not displayed */
	// Default data refresh window on days.
	// Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
	DefaultDataRefreshWindowDays int32 `` /* 153-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,proto3" json:"manual_runs_disabled,omitempty"`
	// The minimum interval for scheduler to schedule runs.
	MinimumScheduleInterval *durationpb.Duration `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines the properties and custom parameters for a data source.

func (*DataSource) Descriptor deprecated

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

Deprecated: Use DataSource.ProtoReflect.Descriptor instead.

func (*DataSource) GetAuthorizationType

func (x *DataSource) GetAuthorizationType() DataSource_AuthorizationType

func (*DataSource) GetClientId

func (x *DataSource) GetClientId() string

func (*DataSource) GetDataRefreshType

func (x *DataSource) GetDataRefreshType() DataSource_DataRefreshType

func (*DataSource) GetDataSourceId

func (x *DataSource) GetDataSourceId() string

func (*DataSource) GetDefaultDataRefreshWindowDays

func (x *DataSource) GetDefaultDataRefreshWindowDays() int32

func (*DataSource) GetDefaultSchedule

func (x *DataSource) GetDefaultSchedule() string

func (*DataSource) GetDescription

func (x *DataSource) GetDescription() string

func (*DataSource) GetDisplayName

func (x *DataSource) GetDisplayName() string

func (*DataSource) GetHelpUrl

func (x *DataSource) GetHelpUrl() string

func (*DataSource) GetManualRunsDisabled

func (x *DataSource) GetManualRunsDisabled() bool

func (*DataSource) GetMinimumScheduleInterval

func (x *DataSource) GetMinimumScheduleInterval() *durationpb.Duration

func (*DataSource) GetName

func (x *DataSource) GetName() string

func (*DataSource) GetParameters

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

func (*DataSource) GetScopes

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

func (*DataSource) GetSupportsCustomSchedule

func (x *DataSource) GetSupportsCustomSchedule() bool

func (*DataSource) GetSupportsMultipleTransfers deprecated

func (x *DataSource) GetSupportsMultipleTransfers() bool

Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.

func (*DataSource) GetTransferType deprecated

func (x *DataSource) GetTransferType() TransferType

Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.

func (*DataSource) GetUpdateDeadlineSeconds

func (x *DataSource) GetUpdateDeadlineSeconds() int32

func (*DataSource) ProtoMessage

func (*DataSource) ProtoMessage()

func (*DataSource) ProtoReflect

func (x *DataSource) ProtoReflect() protoreflect.Message

func (*DataSource) Reset

func (x *DataSource) Reset()

func (*DataSource) String

func (x *DataSource) String() string

type DataSourceParameter

type DataSourceParameter struct {

	// Parameter identifier.
	ParamId string `protobuf:"bytes,1,opt,name=param_id,json=paramId,proto3" json:"param_id,omitempty"`
	// Parameter display name in the user interface.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Parameter description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Parameter type.
	Type DataSourceParameter_Type `` /* 130-byte string literal not displayed */
	// Is parameter required.
	Required bool `protobuf:"varint,5,opt,name=required,proto3" json:"required,omitempty"`
	// Deprecated. This field has no effect.
	Repeated bool `protobuf:"varint,6,opt,name=repeated,proto3" json:"repeated,omitempty"`
	// Regular expression which can be used for parameter validation.
	ValidationRegex string `protobuf:"bytes,7,opt,name=validation_regex,json=validationRegex,proto3" json:"validation_regex,omitempty"`
	// All possible values for the parameter.
	AllowedValues []string `protobuf:"bytes,8,rep,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
	// For integer and double values specifies minimum allowed value.
	MinValue *wrapperspb.DoubleValue `protobuf:"bytes,9,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// For integer and double values specifies maximum allowed value.
	MaxValue *wrapperspb.DoubleValue `protobuf:"bytes,10,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// Deprecated. This field has no effect.
	Fields []*DataSourceParameter `protobuf:"bytes,11,rep,name=fields,proto3" 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,proto3" 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,proto3" json:"validation_help_url,omitempty"`
	// Cannot be changed after initial creation.
	Immutable bool `protobuf:"varint,14,opt,name=immutable,proto3" json:"immutable,omitempty"`
	// Deprecated. This field has no effect.
	Recurse bool `protobuf:"varint,15,opt,name=recurse,proto3" json:"recurse,omitempty"`
	// If true, it should not be used in new transfers, and it should not be
	// visible to users.
	Deprecated bool `protobuf:"varint,20,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// contains filtered or unexported fields
}

A parameter used to define custom fields in a data source definition.

func (*DataSourceParameter) Descriptor deprecated

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

Deprecated: Use DataSourceParameter.ProtoReflect.Descriptor instead.

func (*DataSourceParameter) GetAllowedValues

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

func (*DataSourceParameter) GetDeprecated

func (x *DataSourceParameter) GetDeprecated() bool

func (*DataSourceParameter) GetDescription

func (x *DataSourceParameter) GetDescription() string

func (*DataSourceParameter) GetDisplayName

func (x *DataSourceParameter) GetDisplayName() string

func (*DataSourceParameter) GetFields

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

func (*DataSourceParameter) GetImmutable

func (x *DataSourceParameter) GetImmutable() bool

func (*DataSourceParameter) GetMaxValue

func (x *DataSourceParameter) GetMaxValue() *wrapperspb.DoubleValue

func (*DataSourceParameter) GetMinValue

func (x *DataSourceParameter) GetMinValue() *wrapperspb.DoubleValue

func (*DataSourceParameter) GetParamId

func (x *DataSourceParameter) GetParamId() string

func (*DataSourceParameter) GetRecurse

func (x *DataSourceParameter) GetRecurse() bool

func (*DataSourceParameter) GetRepeated

func (x *DataSourceParameter) GetRepeated() bool

func (*DataSourceParameter) GetRequired

func (x *DataSourceParameter) GetRequired() bool

func (*DataSourceParameter) GetType

func (*DataSourceParameter) GetValidationDescription

func (x *DataSourceParameter) GetValidationDescription() string

func (*DataSourceParameter) GetValidationHelpUrl

func (x *DataSourceParameter) GetValidationHelpUrl() string

func (*DataSourceParameter) GetValidationRegex

func (x *DataSourceParameter) GetValidationRegex() string

func (*DataSourceParameter) ProtoMessage

func (*DataSourceParameter) ProtoMessage()

func (*DataSourceParameter) ProtoReflect

func (x *DataSourceParameter) ProtoReflect() protoreflect.Message

func (*DataSourceParameter) Reset

func (x *DataSourceParameter) Reset()

func (*DataSourceParameter) String

func (x *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
	// Deprecated. This field has no effect.
	DataSourceParameter_RECORD DataSourceParameter_Type = 5
	// Page ID for a Google+ Page.
	DataSourceParameter_PLUS_PAGE DataSourceParameter_Type = 6
)

func (DataSourceParameter_Type) Descriptor

func (DataSourceParameter_Type) Enum

func (DataSourceParameter_Type) EnumDescriptor deprecated

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

Deprecated: Use DataSourceParameter_Type.Descriptor instead.

func (DataSourceParameter_Type) Number

func (DataSourceParameter_Type) String

func (x DataSourceParameter_Type) String() string

func (DataSourceParameter_Type) Type

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
	// Use First Party OAuth.
	DataSource_FIRST_PARTY_OAUTH DataSource_AuthorizationType = 3
)

func (DataSource_AuthorizationType) Descriptor

func (DataSource_AuthorizationType) Enum

func (DataSource_AuthorizationType) EnumDescriptor deprecated

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

Deprecated: Use DataSource_AuthorizationType.Descriptor instead.

func (DataSource_AuthorizationType) Number

func (DataSource_AuthorizationType) String

func (DataSource_AuthorizationType) Type

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) Descriptor

func (DataSource_DataRefreshType) Enum

func (DataSource_DataRefreshType) EnumDescriptor deprecated

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

Deprecated: Use DataSource_DataRefreshType.Descriptor instead.

func (DataSource_DataRefreshType) Number

func (DataSource_DataRefreshType) String

func (DataSource_DataRefreshType) Type

type DataTransferServiceClient

type DataTransferServiceClient interface {
	// Retrieves a supported data source and returns its settings.
	GetDataSource(ctx context.Context, in *GetDataSourceRequest, opts ...grpc.CallOption) (*DataSource, error)
	// Lists supported data sources and returns their settings.
	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) (*emptypb.Empty, error)
	// Returns information about a data transfer config.
	GetTransferConfig(ctx context.Context, in *GetTransferConfigRequest, opts ...grpc.CallOption) (*TransferConfig, error)
	// Returns information about all transfer configs owned by a project in the
	// specified location.
	ListTransferConfigs(ctx context.Context, in *ListTransferConfigsRequest, opts ...grpc.CallOption) (*ListTransferConfigsResponse, error)
	// Deprecated: Do not use.
	// Creates transfer runs for a time range [start_time, end_time].
	// For each date - or whatever granularity the data source supports - in the
	// range, one transfer run is created.
	// Note that runs are created per UTC time in the time range.
	// DEPRECATED: use StartManualTransferRuns instead.
	ScheduleTransferRuns(ctx context.Context, in *ScheduleTransferRunsRequest, opts ...grpc.CallOption) (*ScheduleTransferRunsResponse, error)
	// Start manual transfer runs to be executed now with schedule_time equal to
	// current time. The transfer runs can be created for a time range where the
	// run_time is between start_time (inclusive) and end_time (exclusive), or for
	// a specific run_time.
	StartManualTransferRuns(ctx context.Context, in *StartManualTransferRunsRequest, opts ...grpc.CallOption) (*StartManualTransferRunsResponse, 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) (*emptypb.Empty, error)
	// Returns information about running and completed transfer runs.
	ListTransferRuns(ctx context.Context, in *ListTransferRunsRequest, opts ...grpc.CallOption) (*ListTransferRunsResponse, error)
	// Returns log messages for the 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.
	CheckValidCreds(ctx context.Context, in *CheckValidCredsRequest, opts ...grpc.CallOption) (*CheckValidCredsResponse, error)
	// Enroll data sources in a user project. This allows users to create transfer
	// configurations for these data sources. They will also appear in the
	// ListDataSources RPC and as such, will appear in the
	// [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents
	// can be found in the public guide for
	// [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
	// [Data Transfer
	// Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
	EnrollDataSources(ctx context.Context, in *EnrollDataSourcesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

DataTransferServiceClient is the client API for DataTransferService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type DataTransferServiceServer

type DataTransferServiceServer interface {
	// Retrieves a supported data source and returns its settings.
	GetDataSource(context.Context, *GetDataSourceRequest) (*DataSource, error)
	// Lists supported data sources and returns their settings.
	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) (*emptypb.Empty, error)
	// Returns information about a data transfer config.
	GetTransferConfig(context.Context, *GetTransferConfigRequest) (*TransferConfig, error)
	// Returns information about all transfer configs owned by a project in the
	// specified location.
	ListTransferConfigs(context.Context, *ListTransferConfigsRequest) (*ListTransferConfigsResponse, error)
	// Deprecated: Do not use.
	// Creates transfer runs for a time range [start_time, end_time].
	// For each date - or whatever granularity the data source supports - in the
	// range, one transfer run is created.
	// Note that runs are created per UTC time in the time range.
	// DEPRECATED: use StartManualTransferRuns instead.
	ScheduleTransferRuns(context.Context, *ScheduleTransferRunsRequest) (*ScheduleTransferRunsResponse, error)
	// Start manual transfer runs to be executed now with schedule_time equal to
	// current time. The transfer runs can be created for a time range where the
	// run_time is between start_time (inclusive) and end_time (exclusive), or for
	// a specific run_time.
	StartManualTransferRuns(context.Context, *StartManualTransferRunsRequest) (*StartManualTransferRunsResponse, error)
	// Returns information about the particular transfer run.
	GetTransferRun(context.Context, *GetTransferRunRequest) (*TransferRun, error)
	// Deletes the specified transfer run.
	DeleteTransferRun(context.Context, *DeleteTransferRunRequest) (*emptypb.Empty, error)
	// Returns information about running and completed transfer runs.
	ListTransferRuns(context.Context, *ListTransferRunsRequest) (*ListTransferRunsResponse, error)
	// Returns log messages for the transfer run.
	ListTransferLogs(context.Context, *ListTransferLogsRequest) (*ListTransferLogsResponse, error)
	// Returns true if valid credentials exist for the given data source and
	// requesting user.
	CheckValidCreds(context.Context, *CheckValidCredsRequest) (*CheckValidCredsResponse, error)
	// Enroll data sources in a user project. This allows users to create transfer
	// configurations for these data sources. They will also appear in the
	// ListDataSources RPC and as such, will appear in the
	// [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents
	// can be found in the public guide for
	// [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
	// [Data Transfer
	// Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
	EnrollDataSources(context.Context, *EnrollDataSourcesRequest) (*emptypb.Empty, error)
}

DataTransferServiceServer is the server API for DataTransferService service.

type DeleteTransferConfigRequest

type DeleteTransferConfigRequest struct {

	// Required. The field will contain name of the resource requested, for
	// example: `projects/{project_id}/transferConfigs/{config_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*DeleteTransferConfigRequest) Descriptor deprecated

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

Deprecated: Use DeleteTransferConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteTransferConfigRequest) GetName

func (x *DeleteTransferConfigRequest) GetName() string

func (*DeleteTransferConfigRequest) ProtoMessage

func (*DeleteTransferConfigRequest) ProtoMessage()

func (*DeleteTransferConfigRequest) ProtoReflect

func (*DeleteTransferConfigRequest) Reset

func (x *DeleteTransferConfigRequest) Reset()

func (*DeleteTransferConfigRequest) String

func (x *DeleteTransferConfigRequest) String() string

type DeleteTransferRunRequest

type DeleteTransferRunRequest struct {

	// Required. The field will contain name of the resource requested, for
	// example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
	// or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request to delete data transfer run information.

func (*DeleteTransferRunRequest) Descriptor deprecated

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

Deprecated: Use DeleteTransferRunRequest.ProtoReflect.Descriptor instead.

func (*DeleteTransferRunRequest) GetName

func (x *DeleteTransferRunRequest) GetName() string

func (*DeleteTransferRunRequest) ProtoMessage

func (*DeleteTransferRunRequest) ProtoMessage()

func (*DeleteTransferRunRequest) ProtoReflect

func (x *DeleteTransferRunRequest) ProtoReflect() protoreflect.Message

func (*DeleteTransferRunRequest) Reset

func (x *DeleteTransferRunRequest) Reset()

func (*DeleteTransferRunRequest) String

func (x *DeleteTransferRunRequest) String() string

type EmailPreferences

type EmailPreferences struct {

	// If true, email notifications will be sent on transfer run failures.
	EnableFailureEmail bool `protobuf:"varint,1,opt,name=enable_failure_email,json=enableFailureEmail,proto3" json:"enable_failure_email,omitempty"`
	// contains filtered or unexported fields
}

Represents preferences for sending email notifications for transfer run events.

func (*EmailPreferences) Descriptor deprecated

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

Deprecated: Use EmailPreferences.ProtoReflect.Descriptor instead.

func (*EmailPreferences) GetEnableFailureEmail

func (x *EmailPreferences) GetEnableFailureEmail() bool

func (*EmailPreferences) ProtoMessage

func (*EmailPreferences) ProtoMessage()

func (*EmailPreferences) ProtoReflect

func (x *EmailPreferences) ProtoReflect() protoreflect.Message

func (*EmailPreferences) Reset

func (x *EmailPreferences) Reset()

func (*EmailPreferences) String

func (x *EmailPreferences) String() string

type EnrollDataSourcesRequest

type EnrollDataSourcesRequest struct {

	// The name of the project resource in the form: `projects/{project_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Data sources that are enrolled. It is required to provide at least one
	// data source id.
	DataSourceIds []string `protobuf:"bytes,2,rep,name=data_source_ids,json=dataSourceIds,proto3" json:"data_source_ids,omitempty"`
	// contains filtered or unexported fields
}

A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.

func (*EnrollDataSourcesRequest) Descriptor deprecated

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

Deprecated: Use EnrollDataSourcesRequest.ProtoReflect.Descriptor instead.

func (*EnrollDataSourcesRequest) GetDataSourceIds

func (x *EnrollDataSourcesRequest) GetDataSourceIds() []string

func (*EnrollDataSourcesRequest) GetName

func (x *EnrollDataSourcesRequest) GetName() string

func (*EnrollDataSourcesRequest) ProtoMessage

func (*EnrollDataSourcesRequest) ProtoMessage()

func (*EnrollDataSourcesRequest) ProtoReflect

func (x *EnrollDataSourcesRequest) ProtoReflect() protoreflect.Message

func (*EnrollDataSourcesRequest) Reset

func (x *EnrollDataSourcesRequest) Reset()

func (*EnrollDataSourcesRequest) String

func (x *EnrollDataSourcesRequest) String() string

type GetDataSourceRequest

type GetDataSourceRequest struct {

	// Required. The field will contain name of the resource requested, for
	// example: `projects/{project_id}/dataSources/{data_source_id}` or
	// `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request to get data source info.

func (*GetDataSourceRequest) Descriptor deprecated

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

Deprecated: Use GetDataSourceRequest.ProtoReflect.Descriptor instead.

func (*GetDataSourceRequest) GetName

func (x *GetDataSourceRequest) GetName() string

func (*GetDataSourceRequest) ProtoMessage

func (*GetDataSourceRequest) ProtoMessage()

func (*GetDataSourceRequest) ProtoReflect

func (x *GetDataSourceRequest) ProtoReflect() protoreflect.Message

func (*GetDataSourceRequest) Reset

func (x *GetDataSourceRequest) Reset()

func (*GetDataSourceRequest) String

func (x *GetDataSourceRequest) String() string

type GetTransferConfigRequest

type GetTransferConfigRequest struct {

	// Required. The field will contain name of the resource requested, for
	// example: `projects/{project_id}/transferConfigs/{config_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request to get data transfer information.

func (*GetTransferConfigRequest) Descriptor deprecated

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

Deprecated: Use GetTransferConfigRequest.ProtoReflect.Descriptor instead.

func (*GetTransferConfigRequest) GetName

func (x *GetTransferConfigRequest) GetName() string

func (*GetTransferConfigRequest) ProtoMessage

func (*GetTransferConfigRequest) ProtoMessage()

func (*GetTransferConfigRequest) ProtoReflect

func (x *GetTransferConfigRequest) ProtoReflect() protoreflect.Message

func (*GetTransferConfigRequest) Reset

func (x *GetTransferConfigRequest) Reset()

func (*GetTransferConfigRequest) String

func (x *GetTransferConfigRequest) String() string

type GetTransferRunRequest

type GetTransferRunRequest struct {

	// Required. The field will contain name of the resource requested, for
	// example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
	// or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request to get data transfer run information.

func (*GetTransferRunRequest) Descriptor deprecated

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

Deprecated: Use GetTransferRunRequest.ProtoReflect.Descriptor instead.

func (*GetTransferRunRequest) GetName

func (x *GetTransferRunRequest) GetName() string

func (*GetTransferRunRequest) ProtoMessage

func (*GetTransferRunRequest) ProtoMessage()

func (*GetTransferRunRequest) ProtoReflect

func (x *GetTransferRunRequest) ProtoReflect() protoreflect.Message

func (*GetTransferRunRequest) Reset

func (x *GetTransferRunRequest) Reset()

func (*GetTransferRunRequest) String

func (x *GetTransferRunRequest) String() string

type ListDataSourcesRequest

type ListDataSourcesRequest struct {

	// Required. The BigQuery project id for which data sources should be
	// returned. Must be in the form: `projects/{project_id}` or
	// `projects/{project_id}/locations/{location_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" 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,proto3" 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,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListDataSourcesRequest) Descriptor deprecated

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

Deprecated: Use ListDataSourcesRequest.ProtoReflect.Descriptor instead.

func (*ListDataSourcesRequest) GetPageSize

func (x *ListDataSourcesRequest) GetPageSize() int32

func (*ListDataSourcesRequest) GetPageToken

func (x *ListDataSourcesRequest) GetPageToken() string

func (*ListDataSourcesRequest) GetParent

func (x *ListDataSourcesRequest) GetParent() string

func (*ListDataSourcesRequest) ProtoMessage

func (*ListDataSourcesRequest) ProtoMessage()

func (*ListDataSourcesRequest) ProtoReflect

func (x *ListDataSourcesRequest) ProtoReflect() protoreflect.Message

func (*ListDataSourcesRequest) Reset

func (x *ListDataSourcesRequest) Reset()

func (*ListDataSourcesRequest) String

func (x *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,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Returns list of supported data sources and their metadata.

func (*ListDataSourcesResponse) Descriptor deprecated

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

Deprecated: Use ListDataSourcesResponse.ProtoReflect.Descriptor instead.

func (*ListDataSourcesResponse) GetDataSources

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

func (*ListDataSourcesResponse) GetNextPageToken

func (x *ListDataSourcesResponse) GetNextPageToken() string

func (*ListDataSourcesResponse) ProtoMessage

func (*ListDataSourcesResponse) ProtoMessage()

func (*ListDataSourcesResponse) ProtoReflect

func (x *ListDataSourcesResponse) ProtoReflect() protoreflect.Message

func (*ListDataSourcesResponse) Reset

func (x *ListDataSourcesResponse) Reset()

func (*ListDataSourcesResponse) String

func (x *ListDataSourcesResponse) String() string

type ListTransferConfigsRequest

type ListTransferConfigsRequest struct {

	// Required. The BigQuery project id for which transfer configs
	// should be returned: `projects/{project_id}` or
	// `projects/{project_id}/locations/{location_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" 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,proto3" 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,proto3" 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,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListTransferConfigsRequest) Descriptor deprecated

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

Deprecated: Use ListTransferConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListTransferConfigsRequest) GetDataSourceIds

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

func (*ListTransferConfigsRequest) GetPageSize

func (x *ListTransferConfigsRequest) GetPageSize() int32

func (*ListTransferConfigsRequest) GetPageToken

func (x *ListTransferConfigsRequest) GetPageToken() string

func (*ListTransferConfigsRequest) GetParent

func (x *ListTransferConfigsRequest) GetParent() string

func (*ListTransferConfigsRequest) ProtoMessage

func (*ListTransferConfigsRequest) ProtoMessage()

func (*ListTransferConfigsRequest) ProtoReflect

func (*ListTransferConfigsRequest) Reset

func (x *ListTransferConfigsRequest) Reset()

func (*ListTransferConfigsRequest) String

func (x *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,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The returned list of pipelines in the project.

func (*ListTransferConfigsResponse) Descriptor deprecated

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

Deprecated: Use ListTransferConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListTransferConfigsResponse) GetNextPageToken

func (x *ListTransferConfigsResponse) GetNextPageToken() string

func (*ListTransferConfigsResponse) GetTransferConfigs

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

func (*ListTransferConfigsResponse) ProtoMessage

func (*ListTransferConfigsResponse) ProtoMessage()

func (*ListTransferConfigsResponse) ProtoReflect

func (*ListTransferConfigsResponse) Reset

func (x *ListTransferConfigsResponse) Reset()

func (*ListTransferConfigsResponse) String

func (x *ListTransferConfigsResponse) String() string

type ListTransferLogsRequest

type ListTransferLogsRequest struct {

	// Required. Transfer run name in the form:
	// `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" 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,proto3" 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,proto3" json:"page_size,omitempty"`
	// Message types to return. If not populated - INFO, WARNING and ERROR
	// messages are returned.
	MessageTypes []TransferMessage_MessageSeverity `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*ListTransferLogsRequest) Descriptor deprecated

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

Deprecated: Use ListTransferLogsRequest.ProtoReflect.Descriptor instead.

func (*ListTransferLogsRequest) GetMessageTypes

func (*ListTransferLogsRequest) GetPageSize

func (x *ListTransferLogsRequest) GetPageSize() int32

func (*ListTransferLogsRequest) GetPageToken

func (x *ListTransferLogsRequest) GetPageToken() string

func (*ListTransferLogsRequest) GetParent

func (x *ListTransferLogsRequest) GetParent() string

func (*ListTransferLogsRequest) ProtoMessage

func (*ListTransferLogsRequest) ProtoMessage()

func (*ListTransferLogsRequest) ProtoReflect

func (x *ListTransferLogsRequest) ProtoReflect() protoreflect.Message

func (*ListTransferLogsRequest) Reset

func (x *ListTransferLogsRequest) Reset()

func (*ListTransferLogsRequest) String

func (x *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,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The returned list transfer run messages.

func (*ListTransferLogsResponse) Descriptor deprecated

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

Deprecated: Use ListTransferLogsResponse.ProtoReflect.Descriptor instead.

func (*ListTransferLogsResponse) GetNextPageToken

func (x *ListTransferLogsResponse) GetNextPageToken() string

func (*ListTransferLogsResponse) GetTransferMessages

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

func (*ListTransferLogsResponse) ProtoMessage

func (*ListTransferLogsResponse) ProtoMessage()

func (*ListTransferLogsResponse) ProtoReflect

func (x *ListTransferLogsResponse) ProtoReflect() protoreflect.Message

func (*ListTransferLogsResponse) Reset

func (x *ListTransferLogsResponse) Reset()

func (*ListTransferLogsResponse) String

func (x *ListTransferLogsResponse) String() string

type ListTransferRunsRequest

type ListTransferRunsRequest struct {

	// Required. Name of transfer configuration for which transfer runs should be
	// retrieved. Format of transfer configuration resource name is:
	// `projects/{project_id}/transferConfigs/{config_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// When specified, only transfer runs with requested states are returned.
	States []TransferState `` /* 130-byte string literal not displayed */
	// 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,proto3" 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,proto3" json:"page_size,omitempty"`
	// Indicates how run attempts are to be pulled.
	RunAttempt ListTransferRunsRequest_RunAttempt `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request to list data transfer runs.

func (*ListTransferRunsRequest) Descriptor deprecated

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

Deprecated: Use ListTransferRunsRequest.ProtoReflect.Descriptor instead.

func (*ListTransferRunsRequest) GetPageSize

func (x *ListTransferRunsRequest) GetPageSize() int32

func (*ListTransferRunsRequest) GetPageToken

func (x *ListTransferRunsRequest) GetPageToken() string

func (*ListTransferRunsRequest) GetParent

func (x *ListTransferRunsRequest) GetParent() string

func (*ListTransferRunsRequest) GetRunAttempt

func (*ListTransferRunsRequest) GetStates

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

func (*ListTransferRunsRequest) ProtoMessage

func (*ListTransferRunsRequest) ProtoMessage()

func (*ListTransferRunsRequest) ProtoReflect

func (x *ListTransferRunsRequest) ProtoReflect() protoreflect.Message

func (*ListTransferRunsRequest) Reset

func (x *ListTransferRunsRequest) Reset()

func (*ListTransferRunsRequest) String

func (x *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) Descriptor

func (ListTransferRunsRequest_RunAttempt) Enum

func (ListTransferRunsRequest_RunAttempt) EnumDescriptor deprecated

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

Deprecated: Use ListTransferRunsRequest_RunAttempt.Descriptor instead.

func (ListTransferRunsRequest_RunAttempt) Number

func (ListTransferRunsRequest_RunAttempt) String

func (ListTransferRunsRequest_RunAttempt) Type

type ListTransferRunsResponse

type ListTransferRunsResponse struct {

	// Output only. The stored pipeline transfer runs.
	TransferRuns []*TransferRun `protobuf:"bytes,1,rep,name=transfer_runs,json=transferRuns,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The returned list of pipelines in the project.

func (*ListTransferRunsResponse) Descriptor deprecated

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

Deprecated: Use ListTransferRunsResponse.ProtoReflect.Descriptor instead.

func (*ListTransferRunsResponse) GetNextPageToken

func (x *ListTransferRunsResponse) GetNextPageToken() string

func (*ListTransferRunsResponse) GetTransferRuns

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

func (*ListTransferRunsResponse) ProtoMessage

func (*ListTransferRunsResponse) ProtoMessage()

func (*ListTransferRunsResponse) ProtoReflect

func (x *ListTransferRunsResponse) ProtoReflect() protoreflect.Message

func (*ListTransferRunsResponse) Reset

func (x *ListTransferRunsResponse) Reset()

func (*ListTransferRunsResponse) String

func (x *ListTransferRunsResponse) String() string

type ScheduleOptions

type ScheduleOptions struct {

	// If true, automatic scheduling of data transfer runs for this configuration
	// will be disabled. The runs can be started on ad-hoc basis using
	// StartManualTransferRuns API. When automatic scheduling is disabled, the
	// TransferConfig.schedule field will be ignored.
	DisableAutoScheduling bool `` /* 127-byte string literal not displayed */
	// Specifies time to start scheduling transfer runs. The first run will be
	// scheduled at or after the start time according to a recurrence pattern
	// defined in the schedule string. The start time can be changed at any
	// moment. The time when a data transfer can be trigerred manually is not
	// limited by this option.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Defines time to stop scheduling transfer runs. A transfer run cannot be
	// scheduled at or after the end time. The end time can be changed at any
	// moment. The time when a data transfer can be trigerred manually is not
	// limited by this option.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Options customizing the data transfer schedule.

func (*ScheduleOptions) Descriptor deprecated

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

Deprecated: Use ScheduleOptions.ProtoReflect.Descriptor instead.

func (*ScheduleOptions) GetDisableAutoScheduling

func (x *ScheduleOptions) GetDisableAutoScheduling() bool

func (*ScheduleOptions) GetEndTime

func (x *ScheduleOptions) GetEndTime() *timestamppb.Timestamp

func (*ScheduleOptions) GetStartTime

func (x *ScheduleOptions) GetStartTime() *timestamppb.Timestamp

func (*ScheduleOptions) ProtoMessage

func (*ScheduleOptions) ProtoMessage()

func (*ScheduleOptions) ProtoReflect

func (x *ScheduleOptions) ProtoReflect() protoreflect.Message

func (*ScheduleOptions) Reset

func (x *ScheduleOptions) Reset()

func (*ScheduleOptions) String

func (x *ScheduleOptions) String() string

type ScheduleTransferRunsRequest

type ScheduleTransferRunsRequest struct {

	// Required. Transfer configuration name in the form:
	// `projects/{project_id}/transferConfigs/{config_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Start time of the range of transfer runs. For example,
	// `"2017-05-25T00:00:00+00:00"`.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Required. End time of the range of transfer runs. For example,
	// `"2017-05-30T00:00:00+00:00"`.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

A request to schedule transfer runs for a time range.

func (*ScheduleTransferRunsRequest) Descriptor deprecated

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

Deprecated: Use ScheduleTransferRunsRequest.ProtoReflect.Descriptor instead.

func (*ScheduleTransferRunsRequest) GetEndTime

func (*ScheduleTransferRunsRequest) GetParent

func (x *ScheduleTransferRunsRequest) GetParent() string

func (*ScheduleTransferRunsRequest) GetStartTime

func (*ScheduleTransferRunsRequest) ProtoMessage

func (*ScheduleTransferRunsRequest) ProtoMessage()

func (*ScheduleTransferRunsRequest) ProtoReflect

func (*ScheduleTransferRunsRequest) Reset

func (x *ScheduleTransferRunsRequest) Reset()

func (*ScheduleTransferRunsRequest) String

func (x *ScheduleTransferRunsRequest) String() string

type ScheduleTransferRunsResponse

type ScheduleTransferRunsResponse struct {

	// The transfer runs that were scheduled.
	Runs []*TransferRun `protobuf:"bytes,1,rep,name=runs,proto3" json:"runs,omitempty"`
	// contains filtered or unexported fields
}

A response to schedule transfer runs for a time range.

func (*ScheduleTransferRunsResponse) Descriptor deprecated

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

Deprecated: Use ScheduleTransferRunsResponse.ProtoReflect.Descriptor instead.

func (*ScheduleTransferRunsResponse) GetRuns

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

func (*ScheduleTransferRunsResponse) ProtoMessage

func (*ScheduleTransferRunsResponse) ProtoMessage()

func (*ScheduleTransferRunsResponse) ProtoReflect

func (*ScheduleTransferRunsResponse) Reset

func (x *ScheduleTransferRunsResponse) Reset()

func (*ScheduleTransferRunsResponse) String

type StartManualTransferRunsRequest

type StartManualTransferRunsRequest struct {

	// Transfer configuration name in the form:
	// `projects/{project_id}/transferConfigs/{config_id}` or
	// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The requested time specification - this can be a time range or a specific
	// run_time.
	//
	// Types that are assignable to Time:
	//	*StartManualTransferRunsRequest_RequestedTimeRange
	//	*StartManualTransferRunsRequest_RequestedRunTime
	Time isStartManualTransferRunsRequest_Time `protobuf_oneof:"time"`
	// contains filtered or unexported fields
}

A request to start manual transfer runs.

func (*StartManualTransferRunsRequest) Descriptor deprecated

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

Deprecated: Use StartManualTransferRunsRequest.ProtoReflect.Descriptor instead.

func (*StartManualTransferRunsRequest) GetParent

func (x *StartManualTransferRunsRequest) GetParent() string

func (*StartManualTransferRunsRequest) GetRequestedRunTime

func (x *StartManualTransferRunsRequest) GetRequestedRunTime() *timestamppb.Timestamp

func (*StartManualTransferRunsRequest) GetRequestedTimeRange

func (*StartManualTransferRunsRequest) GetTime

func (m *StartManualTransferRunsRequest) GetTime() isStartManualTransferRunsRequest_Time

func (*StartManualTransferRunsRequest) ProtoMessage

func (*StartManualTransferRunsRequest) ProtoMessage()

func (*StartManualTransferRunsRequest) ProtoReflect

func (*StartManualTransferRunsRequest) Reset

func (x *StartManualTransferRunsRequest) Reset()

func (*StartManualTransferRunsRequest) String

type StartManualTransferRunsRequest_RequestedRunTime

type StartManualTransferRunsRequest_RequestedRunTime struct {
	// Specific run_time for a transfer run to be started. The
	// requested_run_time must not be in the future.
	RequestedRunTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=requested_run_time,json=requestedRunTime,proto3,oneof"`
}

type StartManualTransferRunsRequest_RequestedTimeRange

type StartManualTransferRunsRequest_RequestedTimeRange struct {
	// Time range for the transfer runs that should be started.
	RequestedTimeRange *StartManualTransferRunsRequest_TimeRange `protobuf:"bytes,3,opt,name=requested_time_range,json=requestedTimeRange,proto3,oneof"`
}

type StartManualTransferRunsRequest_TimeRange

type StartManualTransferRunsRequest_TimeRange struct {

	// Start time of the range of transfer runs. For example,
	// `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
	// the end_time. Creates transfer runs where run_time is in the range
	// between start_time (inclusive) and end_time (exclusive).
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End time of the range of transfer runs. For example,
	// `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
	// Creates transfer runs where run_time is in the range between start_time
	// (inclusive) and end_time (exclusive).
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*StartManualTransferRunsRequest_TimeRange) Descriptor deprecated

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

Deprecated: Use StartManualTransferRunsRequest_TimeRange.ProtoReflect.Descriptor instead.

func (*StartManualTransferRunsRequest_TimeRange) GetEndTime

func (*StartManualTransferRunsRequest_TimeRange) GetStartTime

func (*StartManualTransferRunsRequest_TimeRange) ProtoMessage

func (*StartManualTransferRunsRequest_TimeRange) ProtoReflect

func (*StartManualTransferRunsRequest_TimeRange) Reset

func (*StartManualTransferRunsRequest_TimeRange) String

type StartManualTransferRunsResponse

type StartManualTransferRunsResponse struct {

	// The transfer runs that were created.
	Runs []*TransferRun `protobuf:"bytes,1,rep,name=runs,proto3" json:"runs,omitempty"`
	// contains filtered or unexported fields
}

A response to start manual transfer runs.

func (*StartManualTransferRunsResponse) Descriptor deprecated

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

Deprecated: Use StartManualTransferRunsResponse.ProtoReflect.Descriptor instead.

func (*StartManualTransferRunsResponse) GetRuns

func (*StartManualTransferRunsResponse) ProtoMessage

func (*StartManualTransferRunsResponse) ProtoMessage()

func (*StartManualTransferRunsResponse) ProtoReflect

func (*StartManualTransferRunsResponse) Reset

func (*StartManualTransferRunsResponse) String

type TransferConfig

type TransferConfig struct {

	// The resource name of the transfer config.
	// Transfer config names have the form
	// `projects/{project_id}/locations/{region}/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,proto3" json:"name,omitempty"`
	// The desination of the transfer config.
	//
	// Types that are assignable to Destination:
	//	*TransferConfig_DestinationDatasetId
	Destination isTransferConfig_Destination `protobuf_oneof:"destination"`
	// User specified display name for the data transfer.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Data source ID. This cannot be changed once data transfer is created. The
	// full list of available data source IDs can be returned through an API call:
	// https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
	DataSourceId string `protobuf:"bytes,5,opt,name=data_source_id,json=dataSourceId,proto3" json:"data_source_id,omitempty"`
	// Parameters specific to each data source. For more information see the
	// bq tab in the 'Setting up a data transfer' section for each data source.
	// For example the parameters for Cloud Storage transfers are listed here:
	// https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
	Params *structpb.Struct `protobuf:"bytes,9,opt,name=params,proto3" 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 minimum interval time between recurring transfers depends on the
	// data source; refer to the documentation for your data source.
	Schedule string `protobuf:"bytes,7,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Options customizing the data transfer schedule.
	ScheduleOptions *ScheduleOptions `protobuf:"bytes,24,opt,name=schedule_options,json=scheduleOptions,proto3" json:"schedule_options,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 `` /* 130-byte string literal not displayed */
	// Is this config disabled. When set to true, no runs are scheduled
	// for a given transfer.
	Disabled bool `protobuf:"varint,13,opt,name=disabled,proto3" json:"disabled,omitempty"`
	// Output only. Data transfer modification time. Ignored by server on input.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Next time when data transfer will run.
	NextRunTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=next_run_time,json=nextRunTime,proto3" json:"next_run_time,omitempty"`
	// Output only. State of the most recently updated transfer run.
	State TransferState `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.bigquery.datatransfer.v1.TransferState" json:"state,omitempty"`
	// Deprecated. Unique ID of the user on whose behalf transfer is done.
	UserId int64 `protobuf:"varint,11,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Output only. Region in which BigQuery dataset is located.
	DatasetRegion string `protobuf:"bytes,14,opt,name=dataset_region,json=datasetRegion,proto3" json:"dataset_region,omitempty"`
	// Pub/Sub topic where notifications will be sent after transfer runs
	// associated with this transfer config finish.
	//
	// The format for specifying a pubsub topic is:
	// `projects/{project}/topics/{topic}`
	NotificationPubsubTopic string `` /* 133-byte string literal not displayed */
	// Email notifications will be sent according to these preferences
	// to the email address of the user who owns this transfer config.
	EmailPreferences *EmailPreferences `protobuf:"bytes,18,opt,name=email_preferences,json=emailPreferences,proto3" json:"email_preferences,omitempty"`
	// Output only. Information about the user whose credentials are used to
	// transfer data. Populated only for `transferConfigs.get` requests. In case
	// the user information is not available, this field will not be populated.
	OwnerInfo *UserInfo `protobuf:"bytes,27,opt,name=owner_info,json=ownerInfo,proto3,oneof" json:"owner_info,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated

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

Deprecated: Use TransferConfig.ProtoReflect.Descriptor instead.

func (*TransferConfig) GetDataRefreshWindowDays

func (x *TransferConfig) GetDataRefreshWindowDays() int32

func (*TransferConfig) GetDataSourceId

func (x *TransferConfig) GetDataSourceId() string

func (*TransferConfig) GetDatasetRegion

func (x *TransferConfig) GetDatasetRegion() string

func (*TransferConfig) GetDestination

func (m *TransferConfig) GetDestination() isTransferConfig_Destination

func (*TransferConfig) GetDestinationDatasetId

func (x *TransferConfig) GetDestinationDatasetId() string

func (*TransferConfig) GetDisabled

func (x *TransferConfig) GetDisabled() bool

func (*TransferConfig) GetDisplayName

func (x *TransferConfig) GetDisplayName() string

func (*TransferConfig) GetEmailPreferences

func (x *TransferConfig) GetEmailPreferences() *EmailPreferences

func (*TransferConfig) GetName

func (x *TransferConfig) GetName() string

func (*TransferConfig) GetNextRunTime

func (x *TransferConfig) GetNextRunTime() *timestamppb.Timestamp

func (*TransferConfig) GetNotificationPubsubTopic

func (x *TransferConfig) GetNotificationPubsubTopic() string

func (*TransferConfig) GetOwnerInfo

func (x *TransferConfig) GetOwnerInfo() *UserInfo

func (*TransferConfig) GetParams

func (x *TransferConfig) GetParams() *structpb.Struct

func (*TransferConfig) GetSchedule

func (x *TransferConfig) GetSchedule() string

func (*TransferConfig) GetScheduleOptions

func (x *TransferConfig) GetScheduleOptions() *ScheduleOptions

func (*TransferConfig) GetState

func (x *TransferConfig) GetState() TransferState

func (*TransferConfig) GetUpdateTime

func (x *TransferConfig) GetUpdateTime() *timestamppb.Timestamp

func (*TransferConfig) GetUserId

func (x *TransferConfig) GetUserId() int64

func (*TransferConfig) ProtoMessage

func (*TransferConfig) ProtoMessage()

func (*TransferConfig) ProtoReflect

func (x *TransferConfig) ProtoReflect() protoreflect.Message

func (*TransferConfig) Reset

func (x *TransferConfig) Reset()

func (*TransferConfig) String

func (x *TransferConfig) String() string

type TransferConfig_DestinationDatasetId

type TransferConfig_DestinationDatasetId struct {
	// The BigQuery target dataset id.
	DestinationDatasetId string `protobuf:"bytes,2,opt,name=destination_dataset_id,json=destinationDatasetId,proto3,oneof"`
}

type TransferMessage

type TransferMessage struct {

	// Time when message was logged.
	MessageTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=message_time,json=messageTime,proto3" json:"message_time,omitempty"`
	// Message severity.
	Severity TransferMessage_MessageSeverity `` /* 145-byte string literal not displayed */
	// Message text.
	MessageText string `protobuf:"bytes,3,opt,name=message_text,json=messageText,proto3" json:"message_text,omitempty"`
	// contains filtered or unexported fields
}

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

func (*TransferMessage) Descriptor deprecated

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

Deprecated: Use TransferMessage.ProtoReflect.Descriptor instead.

func (*TransferMessage) GetMessageText

func (x *TransferMessage) GetMessageText() string

func (*TransferMessage) GetMessageTime

func (x *TransferMessage) GetMessageTime() *timestamppb.Timestamp

func (*TransferMessage) GetSeverity

func (*TransferMessage) ProtoMessage

func (*TransferMessage) ProtoMessage()

func (*TransferMessage) ProtoReflect

func (x *TransferMessage) ProtoReflect() protoreflect.Message

func (*TransferMessage) Reset

func (x *TransferMessage) Reset()

func (*TransferMessage) String

func (x *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) Descriptor

func (TransferMessage_MessageSeverity) Enum

func (TransferMessage_MessageSeverity) EnumDescriptor deprecated

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

Deprecated: Use TransferMessage_MessageSeverity.Descriptor instead.

func (TransferMessage_MessageSeverity) Number

func (TransferMessage_MessageSeverity) String

func (TransferMessage_MessageSeverity) Type

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,proto3" json:"name,omitempty"`
	// Minimum time after which a transfer run can be started.
	ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
	// For batch transfer runs, specifies the date and time of the data should be
	// ingested.
	RunTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=run_time,json=runTime,proto3" json:"run_time,omitempty"`
	// Status of the transfer run.
	ErrorStatus *status.Status `protobuf:"bytes,21,opt,name=error_status,json=errorStatus,proto3" json:"error_status,omitempty"`
	// Output only. Time when transfer run was started.
	// Parameter ignored by server for input requests.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. Time when transfer run ended.
	// Parameter ignored by server for input requests.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Last time the data transfer run state was updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Parameters specific to each data source. For more information
	// see the bq tab in the 'Setting up a data transfer' section for each data
	// source. For example the parameters for Cloud Storage transfers are listed
	// here:
	// https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
	Params *structpb.Struct `protobuf:"bytes,9,opt,name=params,proto3" json:"params,omitempty"`
	// Data transfer destination.
	//
	// Types that are assignable to Destination:
	//	*TransferRun_DestinationDatasetId
	Destination isTransferRun_Destination `protobuf_oneof:"destination"`
	// Output only. Data source id.
	DataSourceId string `protobuf:"bytes,7,opt,name=data_source_id,json=dataSourceId,proto3" json:"data_source_id,omitempty"`
	// Data transfer run state. Ignored for input requests.
	State TransferState `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.bigquery.datatransfer.v1.TransferState" json:"state,omitempty"`
	// Deprecated. Unique ID of the user on whose behalf transfer is done.
	UserId int64 `protobuf:"varint,11,opt,name=user_id,json=userId,proto3" 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 match this.
	Schedule string `protobuf:"bytes,12,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Output only. Pub/Sub topic where a notification will be sent after this
	// transfer run finishes.
	//
	// The format for specifying a pubsub topic is:
	// `projects/{project}/topics/{topic}`
	NotificationPubsubTopic string `` /* 133-byte string literal not displayed */
	// Output only. Email notifications will be sent according to these
	// preferences to the email address of the user who owns the transfer config
	// this run was derived from.
	EmailPreferences *EmailPreferences `protobuf:"bytes,25,opt,name=email_preferences,json=emailPreferences,proto3" json:"email_preferences,omitempty"`
	// contains filtered or unexported fields
}

Represents a data transfer run.

func (*TransferRun) Descriptor deprecated

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

Deprecated: Use TransferRun.ProtoReflect.Descriptor instead.

func (*TransferRun) GetDataSourceId

func (x *TransferRun) GetDataSourceId() string

func (*TransferRun) GetDestination

func (m *TransferRun) GetDestination() isTransferRun_Destination

func (*TransferRun) GetDestinationDatasetId

func (x *TransferRun) GetDestinationDatasetId() string

func (*TransferRun) GetEmailPreferences

func (x *TransferRun) GetEmailPreferences() *EmailPreferences

func (*TransferRun) GetEndTime

func (x *TransferRun) GetEndTime() *timestamppb.Timestamp

func (*TransferRun) GetErrorStatus

func (x *TransferRun) GetErrorStatus() *status.Status

func (*TransferRun) GetName

func (x *TransferRun) GetName() string

func (*TransferRun) GetNotificationPubsubTopic

func (x *TransferRun) GetNotificationPubsubTopic() string

func (*TransferRun) GetParams

func (x *TransferRun) GetParams() *structpb.Struct

func (*TransferRun) GetRunTime

func (x *TransferRun) GetRunTime() *timestamppb.Timestamp

func (*TransferRun) GetSchedule

func (x *TransferRun) GetSchedule() string

func (*TransferRun) GetScheduleTime

func (x *TransferRun) GetScheduleTime() *timestamppb.Timestamp

func (*TransferRun) GetStartTime

func (x *TransferRun) GetStartTime() *timestamppb.Timestamp

func (*TransferRun) GetState

func (x *TransferRun) GetState() TransferState

func (*TransferRun) GetUpdateTime

func (x *TransferRun) GetUpdateTime() *timestamppb.Timestamp

func (*TransferRun) GetUserId

func (x *TransferRun) GetUserId() int64

func (*TransferRun) ProtoMessage

func (*TransferRun) ProtoMessage()

func (*TransferRun) ProtoReflect

func (x *TransferRun) ProtoReflect() protoreflect.Message

func (*TransferRun) Reset

func (x *TransferRun) Reset()

func (*TransferRun) String

func (x *TransferRun) String() string

type TransferRun_DestinationDatasetId

type TransferRun_DestinationDatasetId struct {
	// Output only. The BigQuery target dataset id.
	DestinationDatasetId string `protobuf:"bytes,2,opt,name=destination_dataset_id,json=destinationDatasetId,proto3,oneof"`
}

type TransferState

type TransferState int32

Represents data transfer run state.

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

func (TransferState) Descriptor

func (TransferState) Enum

func (x TransferState) Enum() *TransferState

func (TransferState) EnumDescriptor deprecated

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

Deprecated: Use TransferState.Descriptor instead.

func (TransferState) Number

func (TransferState) String

func (x TransferState) String() string

func (TransferState) Type

type TransferType deprecated

type TransferType int32

DEPRECATED. Represents data transfer type.

Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/transfer.proto.

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) Descriptor

func (TransferType) Enum

func (x TransferType) Enum() *TransferType

func (TransferType) EnumDescriptor deprecated

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

Deprecated: Use TransferType.Descriptor instead.

func (TransferType) Number

func (TransferType) String

func (x TransferType) String() string

func (TransferType) Type

type UnimplementedDataTransferServiceServer

type UnimplementedDataTransferServiceServer struct {
}

UnimplementedDataTransferServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataTransferServiceServer) CheckValidCreds

func (*UnimplementedDataTransferServiceServer) CreateTransferConfig

func (*UnimplementedDataTransferServiceServer) DeleteTransferConfig

func (*UnimplementedDataTransferServiceServer) DeleteTransferRun

func (*UnimplementedDataTransferServiceServer) EnrollDataSources

func (*UnimplementedDataTransferServiceServer) GetDataSource

func (*UnimplementedDataTransferServiceServer) GetTransferConfig

func (*UnimplementedDataTransferServiceServer) GetTransferRun

func (*UnimplementedDataTransferServiceServer) ListDataSources

func (*UnimplementedDataTransferServiceServer) ListTransferConfigs

func (*UnimplementedDataTransferServiceServer) ListTransferLogs

func (*UnimplementedDataTransferServiceServer) ListTransferRuns

func (*UnimplementedDataTransferServiceServer) ScheduleTransferRuns

func (*UnimplementedDataTransferServiceServer) UpdateTransferConfig

type UpdateTransferConfigRequest

type UpdateTransferConfigRequest struct {

	// Required. Data transfer configuration to create.
	TransferConfig *TransferConfig `protobuf:"bytes,1,opt,name=transfer_config,json=transferConfig,proto3" json:"transfer_config,omitempty"`
	// Optional OAuth2 authorization code to use with this transfer configuration.
	// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
	// and new credentials are needed, as indicated by `CheckValidCreds`. In order
	// to obtain authorization_code, make a request to the following URL:
	// <pre class="prettyprint" suppresswarning="true">
	// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
	// </pre>
	// * The <var>client_id</var> is the OAuth client_id of the a data source as
	// returned by ListDataSources method.
	// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
	// method.
	//
	// Note that this should not be set when `service_account_name` is used to
	// update the transfer config.
	AuthorizationCode string `protobuf:"bytes,3,opt,name=authorization_code,json=authorizationCode,proto3" json:"authorization_code,omitempty"`
	// Required. Required list of fields to be updated in this request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Optional version info. This is required only if
	// `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
	// are needed, as indicated by `CheckValidCreds`. In order to obtain version
	// info, make a request to the following URL:
	// <pre class="prettyprint" suppresswarning="true">
	// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
	// </pre>
	// * The <var>client_id</var> is the OAuth client_id of the a data source as
	// returned by ListDataSources method.
	// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
	// method.
	//
	// Note that this should not be set when `service_account_name` is used to
	// update the transfer config.
	VersionInfo string `protobuf:"bytes,5,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// Optional service account email. If this field is set, the transfer config
	// will be created with this service account's credentials. It requires that
	// the requesting user calling this API has permissions to act as this service
	// account.
	//
	// Note that not all data sources support service account credentials when
	// creating a transfer config. For the latest list of data sources, read about
	// [using service
	// accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
	ServiceAccountName string `protobuf:"bytes,6,opt,name=service_account_name,json=serviceAccountName,proto3" json:"service_account_name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UpdateTransferConfigRequest) Descriptor deprecated

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

Deprecated: Use UpdateTransferConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateTransferConfigRequest) GetAuthorizationCode

func (x *UpdateTransferConfigRequest) GetAuthorizationCode() string

func (*UpdateTransferConfigRequest) GetServiceAccountName

func (x *UpdateTransferConfigRequest) GetServiceAccountName() string

func (*UpdateTransferConfigRequest) GetTransferConfig

func (x *UpdateTransferConfigRequest) GetTransferConfig() *TransferConfig

func (*UpdateTransferConfigRequest) GetUpdateMask

func (*UpdateTransferConfigRequest) GetVersionInfo

func (x *UpdateTransferConfigRequest) GetVersionInfo() string

func (*UpdateTransferConfigRequest) ProtoMessage

func (*UpdateTransferConfigRequest) ProtoMessage()

func (*UpdateTransferConfigRequest) ProtoReflect

func (*UpdateTransferConfigRequest) Reset

func (x *UpdateTransferConfigRequest) Reset()

func (*UpdateTransferConfigRequest) String

func (x *UpdateTransferConfigRequest) String() string

type UserInfo

type UserInfo struct {

	// E-mail address of the user.
	Email *string `protobuf:"bytes,1,opt,name=email,proto3,oneof" json:"email,omitempty"`
	// contains filtered or unexported fields
}

Information about a user.

func (*UserInfo) Descriptor deprecated

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

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetEmail

func (x *UserInfo) GetEmail() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect

func (x *UserInfo) ProtoReflect() protoreflect.Message

func (*UserInfo) Reset

func (x *UserInfo) Reset()

func (*UserInfo) String

func (x *UserInfo) String() string

Jump to

Keyboard shortcuts

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