- 1.72.0 (latest)
- 1.71.0
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.0
- 1.66.2
- 1.65.0
- 1.64.0
- 1.63.1
- 1.62.0
- 1.61.0
- 1.60.0
- 1.59.1
- 1.58.0
- 1.57.1
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.2
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.2
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
Constants
DataTransferService_GetDataSource_FullMethodName, DataTransferService_ListDataSources_FullMethodName, DataTransferService_CreateTransferConfig_FullMethodName, DataTransferService_UpdateTransferConfig_FullMethodName, DataTransferService_DeleteTransferConfig_FullMethodName, DataTransferService_GetTransferConfig_FullMethodName, DataTransferService_ListTransferConfigs_FullMethodName, DataTransferService_ScheduleTransferRuns_FullMethodName, DataTransferService_StartManualTransferRuns_FullMethodName, DataTransferService_GetTransferRun_FullMethodName, DataTransferService_DeleteTransferRun_FullMethodName, DataTransferService_ListTransferRuns_FullMethodName, DataTransferService_ListTransferLogs_FullMethodName, DataTransferService_CheckValidCreds_FullMethodName, DataTransferService_EnrollDataSources_FullMethodName, DataTransferService_UnenrollDataSources_FullMethodName
const (
DataTransferService_GetDataSource_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/GetDataSource"
DataTransferService_ListDataSources_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/ListDataSources"
DataTransferService_CreateTransferConfig_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/CreateTransferConfig"
DataTransferService_UpdateTransferConfig_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/UpdateTransferConfig"
DataTransferService_DeleteTransferConfig_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/DeleteTransferConfig"
DataTransferService_GetTransferConfig_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/GetTransferConfig"
DataTransferService_ListTransferConfigs_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/ListTransferConfigs"
DataTransferService_ScheduleTransferRuns_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/ScheduleTransferRuns"
DataTransferService_StartManualTransferRuns_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/StartManualTransferRuns"
DataTransferService_GetTransferRun_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/GetTransferRun"
DataTransferService_DeleteTransferRun_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/DeleteTransferRun"
DataTransferService_ListTransferRuns_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/ListTransferRuns"
DataTransferService_ListTransferLogs_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/ListTransferLogs"
DataTransferService_CheckValidCreds_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/CheckValidCreds"
DataTransferService_EnrollDataSources_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/EnrollDataSources"
DataTransferService_UnenrollDataSources_FullMethodName = "/google.cloud.bigquery.datatransfer.v1.DataTransferService/UnenrollDataSources"
)Variables
DataSourceParameter_Type_name, DataSourceParameter_Type_value
var (
DataSourceParameter_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "STRING",
2: "INTEGER",
3: "DOUBLE",
4: "BOOLEAN",
5: "RECORD",
6: "PLUS_PAGE",
7: "LIST",
}
DataSourceParameter_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"STRING": 1,
"INTEGER": 2,
"DOUBLE": 3,
"BOOLEAN": 4,
"RECORD": 5,
"PLUS_PAGE": 6,
"LIST": 7,
}
)Enum value maps for DataSourceParameter_Type.
DataSource_AuthorizationType_name, DataSource_AuthorizationType_value
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.
DataSource_DataRefreshType_name, DataSource_DataRefreshType_value
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.
ListTransferRunsRequest_RunAttempt_name, ListTransferRunsRequest_RunAttempt_value
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.
TransferType_name, TransferType_value
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.
TransferState_name, TransferState_value
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.
TransferMessage_MessageSeverity_name, TransferMessage_MessageSeverity_value
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.
DataTransferService_ServiceDesc
var DataTransferService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.bigquery.datatransfer.v1.DataTransferService",
HandlerType: (*DataTransferServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetDataSource",
Handler: _DataTransferService_GetDataSource_Handler,
},
{
MethodName: "ListDataSources",
Handler: _DataTransferService_ListDataSources_Handler,
},
{
MethodName: "CreateTransferConfig",
Handler: _DataTransferService_CreateTransferConfig_Handler,
},
{
MethodName: "UpdateTransferConfig",
Handler: _DataTransferService_UpdateTransferConfig_Handler,
},
{
MethodName: "DeleteTransferConfig",
Handler: _DataTransferService_DeleteTransferConfig_Handler,
},
{
MethodName: "GetTransferConfig",
Handler: _DataTransferService_GetTransferConfig_Handler,
},
{
MethodName: "ListTransferConfigs",
Handler: _DataTransferService_ListTransferConfigs_Handler,
},
{
MethodName: "ScheduleTransferRuns",
Handler: _DataTransferService_ScheduleTransferRuns_Handler,
},
{
MethodName: "StartManualTransferRuns",
Handler: _DataTransferService_StartManualTransferRuns_Handler,
},
{
MethodName: "GetTransferRun",
Handler: _DataTransferService_GetTransferRun_Handler,
},
{
MethodName: "DeleteTransferRun",
Handler: _DataTransferService_DeleteTransferRun_Handler,
},
{
MethodName: "ListTransferRuns",
Handler: _DataTransferService_ListTransferRuns_Handler,
},
{
MethodName: "ListTransferLogs",
Handler: _DataTransferService_ListTransferLogs_Handler,
},
{
MethodName: "CheckValidCreds",
Handler: _DataTransferService_CheckValidCreds_Handler,
},
{
MethodName: "EnrollDataSources",
Handler: _DataTransferService_EnrollDataSources_Handler,
},
{
MethodName: "UnenrollDataSources",
Handler: _DataTransferService_UnenrollDataSources_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/bigquery/datatransfer/v1/datatransfer.proto",
}DataTransferService_ServiceDesc is the grpc.ServiceDesc for DataTransferService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_bigquery_datatransfer_v1_datatransfer_proto
var File_google_cloud_bigquery_datatransfer_v1_datatransfer_proto protoreflect.FileDescriptorFile_google_cloud_bigquery_datatransfer_v1_transfer_proto
var File_google_cloud_bigquery_datatransfer_v1_transfer_proto protoreflect.FileDescriptorFunctions
func RegisterDataTransferServiceServer
func RegisterDataTransferServiceServer(s grpc.ServiceRegistrar, srv DataTransferServiceServer)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
func (*CheckValidCredsRequest) Descriptor() ([]byte, []int)Deprecated: Use CheckValidCredsRequest.ProtoReflect.Descriptor instead.
func (*CheckValidCredsRequest) GetName
func (x *CheckValidCredsRequest) GetName() stringfunc (*CheckValidCredsRequest) ProtoMessage
func (*CheckValidCredsRequest) ProtoMessage()func (*CheckValidCredsRequest) ProtoReflect
func (x *CheckValidCredsRequest) ProtoReflect() protoreflect.Messagefunc (*CheckValidCredsRequest) Reset
func (x *CheckValidCredsRequest) Reset()func (*CheckValidCredsRequest) String
func (x *CheckValidCredsRequest) String() stringCheckValidCredsResponse
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
func (*CheckValidCredsResponse) Descriptor() ([]byte, []int)Deprecated: Use CheckValidCredsResponse.ProtoReflect.Descriptor instead.
func (*CheckValidCredsResponse) GetHasValidCreds
func (x *CheckValidCredsResponse) GetHasValidCreds() boolfunc (*CheckValidCredsResponse) ProtoMessage
func (*CheckValidCredsResponse) ProtoMessage()func (*CheckValidCredsResponse) ProtoReflect
func (x *CheckValidCredsResponse) ProtoReflect() protoreflect.Messagefunc (*CheckValidCredsResponse) Reset
func (x *CheckValidCredsResponse) Reset()func (*CheckValidCredsResponse) String
func (x *CheckValidCredsResponse) String() stringCreateTransferConfigRequest
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"`
// Deprecated: Authorization code was required when
// `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used
// in any data sources. Use `version_info` instead.
//
// Optional OAuth2 authorization code to use with this transfer configuration.
// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
// and new credentials are needed, as indicated by `CheckValidCreds`. In order
// to obtain authorization_code, make a request to the following URL:
// // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
// // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes //
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.
When using a cross project service account for creating a transfer config, you must enable cross project service account usage. For more information, see Disable attachment of service accounts to resources in other projects.
func (*CreateTransferConfigRequest) Descriptor
func (*CreateTransferConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateTransferConfigRequest.ProtoReflect.Descriptor instead.
func (*CreateTransferConfigRequest) GetAuthorizationCode
func (x *CreateTransferConfigRequest) GetAuthorizationCode() stringDeprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
func (*CreateTransferConfigRequest) GetParent
func (x *CreateTransferConfigRequest) GetParent() stringfunc (*CreateTransferConfigRequest) GetServiceAccountName
func (x *CreateTransferConfigRequest) GetServiceAccountName() stringfunc (*CreateTransferConfigRequest) GetTransferConfig
func (x *CreateTransferConfigRequest) GetTransferConfig() *TransferConfigfunc (*CreateTransferConfigRequest) GetVersionInfo
func (x *CreateTransferConfigRequest) GetVersionInfo() stringfunc (*CreateTransferConfigRequest) ProtoMessage
func (*CreateTransferConfigRequest) ProtoMessage()func (*CreateTransferConfigRequest) ProtoReflect
func (x *CreateTransferConfigRequest) ProtoReflect() protoreflect.Messagefunc (*CreateTransferConfigRequest) Reset
func (x *CreateTransferConfigRequest) Reset()func (*CreateTransferConfigRequest) String
func (x *CreateTransferConfigRequest) String() stringDataSource
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 `protobuf:"varint,7,opt,name=transfer_type,json=transferType,proto3,enum=google.cloud.bigquery.datatransfer.v1.TransferType" json:"transfer_type,omitempty"`
// Deprecated. This field has no effect.
//
// Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
SupportsMultipleTransfers bool `protobuf:"varint,8,opt,name=supports_multiple_transfers,json=supportsMultipleTransfers,proto3" json:"supports_multiple_transfers,omitempty"`
// 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 `protobuf:"varint,9,opt,name=update_deadline_seconds,json=updateDeadlineSeconds,proto3" 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,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 `protobuf:"varint,11,opt,name=supports_custom_schedule,json=supportsCustomSchedule,proto3" json:"supports_custom_schedule,omitempty"`
// 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 `protobuf:"varint,14,opt,name=authorization_type,json=authorizationType,proto3,enum=google.cloud.bigquery.datatransfer.v1.DataSource_AuthorizationType" json:"authorization_type,omitempty"`
// 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 `protobuf:"varint,15,opt,name=data_refresh_type,json=dataRefreshType,proto3,enum=google.cloud.bigquery.datatransfer.v1.DataSource_DataRefreshType" json:"data_refresh_type,omitempty"`
// Default data refresh window on days.
// Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
DefaultDataRefreshWindowDays int32 `protobuf:"varint,16,opt,name=default_data_refresh_window_days,json=defaultDataRefreshWindowDays,proto3" json:"default_data_refresh_window_days,omitempty"`
// 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 `protobuf:"bytes,18,opt,name=minimum_schedule_interval,json=minimumScheduleInterval,proto3" json:"minimum_schedule_interval,omitempty"`
// contains filtered or unexported fields
}Defines the properties and custom parameters for a data source.
func (*DataSource) Descriptor
func (*DataSource) Descriptor() ([]byte, []int)Deprecated: Use DataSource.ProtoReflect.Descriptor instead.
func (*DataSource) GetAuthorizationType
func (x *DataSource) GetAuthorizationType() DataSource_AuthorizationTypefunc (*DataSource) GetClientId
func (x *DataSource) GetClientId() stringfunc (*DataSource) GetDataRefreshType
func (x *DataSource) GetDataRefreshType() DataSource_DataRefreshTypefunc (*DataSource) GetDataSourceId
func (x *DataSource) GetDataSourceId() stringfunc (*DataSource) GetDefaultDataRefreshWindowDays
func (x *DataSource) GetDefaultDataRefreshWindowDays() int32func (*DataSource) GetDefaultSchedule
func (x *DataSource) GetDefaultSchedule() stringfunc (*DataSource) GetDescription
func (x *DataSource) GetDescription() stringfunc (*DataSource) GetDisplayName
func (x *DataSource) GetDisplayName() stringfunc (*DataSource) GetHelpUrl
func (x *DataSource) GetHelpUrl() stringfunc (*DataSource) GetManualRunsDisabled
func (x *DataSource) GetManualRunsDisabled() boolfunc (*DataSource) GetMinimumScheduleInterval
func (x *DataSource) GetMinimumScheduleInterval() *durationpb.Durationfunc (*DataSource) GetName
func (x *DataSource) GetName() stringfunc (*DataSource) GetParameters
func (x *DataSource) GetParameters() []*DataSourceParameterfunc (*DataSource) GetScopes
func (x *DataSource) GetScopes() []stringfunc (*DataSource) GetSupportsCustomSchedule
func (x *DataSource) GetSupportsCustomSchedule() boolfunc (*DataSource) GetSupportsMultipleTransfers
func (x *DataSource) GetSupportsMultipleTransfers() boolDeprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
func (*DataSource) GetTransferType
func (x *DataSource) GetTransferType() TransferTypeDeprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
func (*DataSource) GetUpdateDeadlineSeconds
func (x *DataSource) GetUpdateDeadlineSeconds() int32func (*DataSource) ProtoMessage
func (*DataSource) ProtoMessage()func (*DataSource) ProtoReflect
func (x *DataSource) ProtoReflect() protoreflect.Messagefunc (*DataSource) Reset
func (x *DataSource) Reset()func (*DataSource) String
func (x *DataSource) String() stringDataSourceParameter
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 `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.bigquery.datatransfer.v1.DataSourceParameter_Type" json:"type,omitempty"`
// 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
func (*DataSourceParameter) Descriptor() ([]byte, []int)Deprecated: Use DataSourceParameter.ProtoReflect.Descriptor instead.
func (*DataSourceParameter) GetAllowedValues
func (x *DataSourceParameter) GetAllowedValues() []stringfunc (*DataSourceParameter) GetDeprecated
func (x *DataSourceParameter) GetDeprecated() boolfunc (*DataSourceParameter) GetDescription
func (x *DataSourceParameter) GetDescription() stringfunc (*DataSourceParameter) GetDisplayName
func (x *DataSourceParameter) GetDisplayName() stringfunc (*DataSourceParameter) GetFields
func (x *DataSourceParameter) GetFields() []*DataSourceParameterfunc (*DataSourceParameter) GetImmutable
func (x *DataSourceParameter) GetImmutable() boolfunc (*DataSourceParameter) GetMaxValue
func (x *DataSourceParameter) GetMaxValue() *wrapperspb.DoubleValuefunc (*DataSourceParameter) GetMinValue
func (x *DataSourceParameter) GetMinValue() *wrapperspb.DoubleValuefunc (*DataSourceParameter) GetParamId
func (x *DataSourceParameter) GetParamId() stringfunc (*DataSourceParameter) GetRecurse
func (x *DataSourceParameter) GetRecurse() boolfunc (*DataSourceParameter) GetRepeated
func (x *DataSourceParameter) GetRepeated() boolfunc (*DataSourceParameter) GetRequired
func (x *DataSourceParameter) GetRequired() boolfunc (*DataSourceParameter) GetType
func (x *DataSourceParameter) GetType() DataSourceParameter_Typefunc (*DataSourceParameter) GetValidationDescription
func (x *DataSourceParameter) GetValidationDescription() stringfunc (*DataSourceParameter) GetValidationHelpUrl
func (x *DataSourceParameter) GetValidationHelpUrl() stringfunc (*DataSourceParameter) GetValidationRegex
func (x *DataSourceParameter) GetValidationRegex() stringfunc (*DataSourceParameter) ProtoMessage
func (*DataSourceParameter) ProtoMessage()func (*DataSourceParameter) ProtoReflect
func (x *DataSourceParameter) ProtoReflect() protoreflect.Messagefunc (*DataSourceParameter) Reset
func (x *DataSourceParameter) Reset()func (*DataSourceParameter) String
func (x *DataSourceParameter) String() stringDataSourceParameter_Type
type DataSourceParameter_Type int32Parameter type.
DataSourceParameter_TYPE_UNSPECIFIED, DataSourceParameter_STRING, DataSourceParameter_INTEGER, DataSourceParameter_DOUBLE, DataSourceParameter_BOOLEAN, DataSourceParameter_RECORD, DataSourceParameter_PLUS_PAGE, DataSourceParameter_LIST
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
// List of strings parameter.
DataSourceParameter_LIST DataSourceParameter_Type = 7
)func (DataSourceParameter_Type) Descriptor
func (DataSourceParameter_Type) Descriptor() protoreflect.EnumDescriptorfunc (DataSourceParameter_Type) Enum
func (x DataSourceParameter_Type) Enum() *DataSourceParameter_Typefunc (DataSourceParameter_Type) EnumDescriptor
func (DataSourceParameter_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use DataSourceParameter_Type.Descriptor instead.
func (DataSourceParameter_Type) Number
func (x DataSourceParameter_Type) Number() protoreflect.EnumNumberfunc (DataSourceParameter_Type) String
func (x DataSourceParameter_Type) String() stringfunc (DataSourceParameter_Type) Type
func (DataSourceParameter_Type) Type() protoreflect.EnumTypeDataSource_AuthorizationType
type DataSource_AuthorizationType int32The type of authorization needed for this data source.
DataSource_AUTHORIZATION_TYPE_UNSPECIFIED, DataSource_AUTHORIZATION_CODE, DataSource_GOOGLE_PLUS_AUTHORIZATION_CODE, DataSource_FIRST_PARTY_OAUTH
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) Descriptor() protoreflect.EnumDescriptorfunc (DataSource_AuthorizationType) Enum
func (x DataSource_AuthorizationType) Enum() *DataSource_AuthorizationTypefunc (DataSource_AuthorizationType) EnumDescriptor
func (DataSource_AuthorizationType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataSource_AuthorizationType.Descriptor instead.
func (DataSource_AuthorizationType) Number
func (x DataSource_AuthorizationType) Number() protoreflect.EnumNumberfunc (DataSource_AuthorizationType) String
func (x DataSource_AuthorizationType) String() stringfunc (DataSource_AuthorizationType) Type
func (DataSource_AuthorizationType) Type() protoreflect.EnumTypeDataSource_DataRefreshType
type DataSource_DataRefreshType int32Represents how the data source supports data auto refresh.
DataSource_DATA_REFRESH_TYPE_UNSPECIFIED, DataSource_SLIDING_WINDOW, DataSource_CUSTOM_SLIDING_WINDOW
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) Descriptor() protoreflect.EnumDescriptorfunc (DataSource_DataRefreshType) Enum
func (x DataSource_DataRefreshType) Enum() *DataSource_DataRefreshTypefunc (DataSource_DataRefreshType) EnumDescriptor
func (DataSource_DataRefreshType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataSource_DataRefreshType.Descriptor instead.
func (DataSource_DataRefreshType) Number
func (x DataSource_DataRefreshType) Number() protoreflect.EnumNumberfunc (DataSource_DataRefreshType) String
func (x DataSource_DataRefreshType) String() stringfunc (DataSource_DataRefreshType) Type
func (DataSource_DataRefreshType) Type() protoreflect.EnumTypeDataTransferServiceClient
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)
// Unenroll data sources in a user project. This allows users to remove
// transfer configurations for these data sources. They will no longer appear
// in the ListDataSources RPC and will also no longer appear in the [BigQuery
// UI](https://console.cloud.google.com/bigquery). Data transfers
// configurations of unenrolled data sources will not be scheduled.
UnenrollDataSources(ctx context.Context, in *UnenrollDataSourcesRequest, 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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDataTransferServiceClient
func NewDataTransferServiceClient(cc grpc.ClientConnInterface) DataTransferServiceClientDataTransferServiceServer
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)
// Unenroll data sources in a user project. This allows users to remove
// transfer configurations for these data sources. They will no longer appear
// in the ListDataSources RPC and will also no longer appear in the [BigQuery
// UI](https://console.cloud.google.com/bigquery). Data transfers
// configurations of unenrolled data sources will not be scheduled.
UnenrollDataSources(context.Context, *UnenrollDataSourcesRequest) (*emptypb.Empty, error)
}DataTransferServiceServer is the server API for DataTransferService service. All implementations should embed UnimplementedDataTransferServiceServer for forward compatibility
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
func (*DeleteTransferConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTransferConfigRequest.ProtoReflect.Descriptor instead.
func (*DeleteTransferConfigRequest) GetName
func (x *DeleteTransferConfigRequest) GetName() stringfunc (*DeleteTransferConfigRequest) ProtoMessage
func (*DeleteTransferConfigRequest) ProtoMessage()func (*DeleteTransferConfigRequest) ProtoReflect
func (x *DeleteTransferConfigRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTransferConfigRequest) Reset
func (x *DeleteTransferConfigRequest) Reset()func (*DeleteTransferConfigRequest) String
func (x *DeleteTransferConfigRequest) String() stringDeleteTransferRunRequest
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
func (*DeleteTransferRunRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTransferRunRequest.ProtoReflect.Descriptor instead.
func (*DeleteTransferRunRequest) GetName
func (x *DeleteTransferRunRequest) GetName() stringfunc (*DeleteTransferRunRequest) ProtoMessage
func (*DeleteTransferRunRequest) ProtoMessage()func (*DeleteTransferRunRequest) ProtoReflect
func (x *DeleteTransferRunRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTransferRunRequest) Reset
func (x *DeleteTransferRunRequest) Reset()func (*DeleteTransferRunRequest) String
func (x *DeleteTransferRunRequest) String() stringEmailPreferences
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
func (*EmailPreferences) Descriptor() ([]byte, []int)Deprecated: Use EmailPreferences.ProtoReflect.Descriptor instead.
func (*EmailPreferences) GetEnableFailureEmail
func (x *EmailPreferences) GetEnableFailureEmail() boolfunc (*EmailPreferences) ProtoMessage
func (*EmailPreferences) ProtoMessage()func (*EmailPreferences) ProtoReflect
func (x *EmailPreferences) ProtoReflect() protoreflect.Messagefunc (*EmailPreferences) Reset
func (x *EmailPreferences) Reset()func (*EmailPreferences) String
func (x *EmailPreferences) String() stringEncryptionConfiguration
type EncryptionConfiguration struct {
// The name of the KMS key used for encrypting BigQuery data.
KmsKeyName *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// contains filtered or unexported fields
}Represents the encryption configuration for a transfer.
func (*EncryptionConfiguration) Descriptor
func (*EncryptionConfiguration) Descriptor() ([]byte, []int)Deprecated: Use EncryptionConfiguration.ProtoReflect.Descriptor instead.
func (*EncryptionConfiguration) GetKmsKeyName
func (x *EncryptionConfiguration) GetKmsKeyName() *wrapperspb.StringValuefunc (*EncryptionConfiguration) ProtoMessage
func (*EncryptionConfiguration) ProtoMessage()func (*EncryptionConfiguration) ProtoReflect
func (x *EncryptionConfiguration) ProtoReflect() protoreflect.Messagefunc (*EncryptionConfiguration) Reset
func (x *EncryptionConfiguration) Reset()func (*EncryptionConfiguration) String
func (x *EncryptionConfiguration) String() stringEnrollDataSourcesRequest
type EnrollDataSourcesRequest struct {
// Required. 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
func (*EnrollDataSourcesRequest) Descriptor() ([]byte, []int)Deprecated: Use EnrollDataSourcesRequest.ProtoReflect.Descriptor instead.
func (*EnrollDataSourcesRequest) GetDataSourceIds
func (x *EnrollDataSourcesRequest) GetDataSourceIds() []stringfunc (*EnrollDataSourcesRequest) GetName
func (x *EnrollDataSourcesRequest) GetName() stringfunc (*EnrollDataSourcesRequest) ProtoMessage
func (*EnrollDataSourcesRequest) ProtoMessage()func (*EnrollDataSourcesRequest) ProtoReflect
func (x *EnrollDataSourcesRequest) ProtoReflect() protoreflect.Messagefunc (*EnrollDataSourcesRequest) Reset
func (x *EnrollDataSourcesRequest) Reset()func (*EnrollDataSourcesRequest) String
func (x *EnrollDataSourcesRequest) String() stringEventDrivenSchedule
type EventDrivenSchedule struct {
// Pub/Sub subscription name used to receive events.
// Only Google Cloud Storage data source support this option.
// Format: projects/{project}/subscriptions/{subscription}
PubsubSubscription string `protobuf:"bytes,1,opt,name=pubsub_subscription,json=pubsubSubscription,proto3" json:"pubsub_subscription,omitempty"`
// contains filtered or unexported fields
}Options customizing EventDriven transfers schedule.
func (*EventDrivenSchedule) Descriptor
func (*EventDrivenSchedule) Descriptor() ([]byte, []int)Deprecated: Use EventDrivenSchedule.ProtoReflect.Descriptor instead.
func (*EventDrivenSchedule) GetPubsubSubscription
func (x *EventDrivenSchedule) GetPubsubSubscription() stringfunc (*EventDrivenSchedule) ProtoMessage
func (*EventDrivenSchedule) ProtoMessage()func (*EventDrivenSchedule) ProtoReflect
func (x *EventDrivenSchedule) ProtoReflect() protoreflect.Messagefunc (*EventDrivenSchedule) Reset
func (x *EventDrivenSchedule) Reset()func (*EventDrivenSchedule) String
func (x *EventDrivenSchedule) String() stringGetDataSourceRequest
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
func (*GetDataSourceRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDataSourceRequest.ProtoReflect.Descriptor instead.
func (*GetDataSourceRequest) GetName
func (x *GetDataSourceRequest) GetName() stringfunc (*GetDataSourceRequest) ProtoMessage
func (*GetDataSourceRequest) ProtoMessage()func (*GetDataSourceRequest) ProtoReflect
func (x *GetDataSourceRequest) ProtoReflect() protoreflect.Messagefunc (*GetDataSourceRequest) Reset
func (x *GetDataSourceRequest) Reset()func (*GetDataSourceRequest) String
func (x *GetDataSourceRequest) String() stringGetTransferConfigRequest
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
func (*GetTransferConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTransferConfigRequest.ProtoReflect.Descriptor instead.
func (*GetTransferConfigRequest) GetName
func (x *GetTransferConfigRequest) GetName() stringfunc (*GetTransferConfigRequest) ProtoMessage
func (*GetTransferConfigRequest) ProtoMessage()func (*GetTransferConfigRequest) ProtoReflect
func (x *GetTransferConfigRequest) ProtoReflect() protoreflect.Messagefunc (*GetTransferConfigRequest) Reset
func (x *GetTransferConfigRequest) Reset()func (*GetTransferConfigRequest) String
func (x *GetTransferConfigRequest) String() stringGetTransferRunRequest
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
func (*GetTransferRunRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTransferRunRequest.ProtoReflect.Descriptor instead.
func (*GetTransferRunRequest) GetName
func (x *GetTransferRunRequest) GetName() stringfunc (*GetTransferRunRequest) ProtoMessage
func (*GetTransferRunRequest) ProtoMessage()func (*GetTransferRunRequest) ProtoReflect
func (x *GetTransferRunRequest) ProtoReflect() protoreflect.Messagefunc (*GetTransferRunRequest) Reset
func (x *GetTransferRunRequest) Reset()func (*GetTransferRunRequest) String
func (x *GetTransferRunRequest) String() stringListDataSourcesRequest
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
func (*ListDataSourcesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDataSourcesRequest.ProtoReflect.Descriptor instead.
func (*ListDataSourcesRequest) GetPageSize
func (x *ListDataSourcesRequest) GetPageSize() int32func (*ListDataSourcesRequest) GetPageToken
func (x *ListDataSourcesRequest) GetPageToken() stringfunc (*ListDataSourcesRequest) GetParent
func (x *ListDataSourcesRequest) GetParent() stringfunc (*ListDataSourcesRequest) ProtoMessage
func (*ListDataSourcesRequest) ProtoMessage()func (*ListDataSourcesRequest) ProtoReflect
func (x *ListDataSourcesRequest) ProtoReflect() protoreflect.Messagefunc (*ListDataSourcesRequest) Reset
func (x *ListDataSourcesRequest) Reset()func (*ListDataSourcesRequest) String
func (x *ListDataSourcesRequest) String() stringListDataSourcesResponse
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
func (*ListDataSourcesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDataSourcesResponse.ProtoReflect.Descriptor instead.
func (*ListDataSourcesResponse) GetDataSources
func (x *ListDataSourcesResponse) GetDataSources() []*DataSourcefunc (*ListDataSourcesResponse) GetNextPageToken
func (x *ListDataSourcesResponse) GetNextPageToken() stringfunc (*ListDataSourcesResponse) ProtoMessage
func (*ListDataSourcesResponse) ProtoMessage()func (*ListDataSourcesResponse) ProtoReflect
func (x *ListDataSourcesResponse) ProtoReflect() protoreflect.Messagefunc (*ListDataSourcesResponse) Reset
func (x *ListDataSourcesResponse) Reset()func (*ListDataSourcesResponse) String
func (x *ListDataSourcesResponse) String() stringListTransferConfigsRequest
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
func (*ListTransferConfigsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTransferConfigsRequest.ProtoReflect.Descriptor instead.
func (*ListTransferConfigsRequest) GetDataSourceIds
func (x *ListTransferConfigsRequest) GetDataSourceIds() []stringfunc (*ListTransferConfigsRequest) GetPageSize
func (x *ListTransferConfigsRequest) GetPageSize() int32func (*ListTransferConfigsRequest) GetPageToken
func (x *ListTransferConfigsRequest) GetPageToken() stringfunc (*ListTransferConfigsRequest) GetParent
func (x *ListTransferConfigsRequest) GetParent() stringfunc (*ListTransferConfigsRequest) ProtoMessage
func (*ListTransferConfigsRequest) ProtoMessage()func (*ListTransferConfigsRequest) ProtoReflect
func (x *ListTransferConfigsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTransferConfigsRequest) Reset
func (x *ListTransferConfigsRequest) Reset()func (*ListTransferConfigsRequest) String
func (x *ListTransferConfigsRequest) String() stringListTransferConfigsResponse
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
func (*ListTransferConfigsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTransferConfigsResponse.ProtoReflect.Descriptor instead.
func (*ListTransferConfigsResponse) GetNextPageToken
func (x *ListTransferConfigsResponse) GetNextPageToken() stringfunc (*ListTransferConfigsResponse) GetTransferConfigs
func (x *ListTransferConfigsResponse) GetTransferConfigs() []*TransferConfigfunc (*ListTransferConfigsResponse) ProtoMessage
func (*ListTransferConfigsResponse) ProtoMessage()func (*ListTransferConfigsResponse) ProtoReflect
func (x *ListTransferConfigsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTransferConfigsResponse) Reset
func (x *ListTransferConfigsResponse) Reset()func (*ListTransferConfigsResponse) String
func (x *ListTransferConfigsResponse) String() stringListTransferLogsRequest
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 `protobuf:"varint,6,rep,packed,name=message_types,json=messageTypes,proto3,enum=google.cloud.bigquery.datatransfer.v1.TransferMessage_MessageSeverity" json:"message_types,omitempty"`
// contains filtered or unexported fields
}A request to get user facing log messages associated with data transfer run.
func (*ListTransferLogsRequest) Descriptor
func (*ListTransferLogsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTransferLogsRequest.ProtoReflect.Descriptor instead.
func (*ListTransferLogsRequest) GetMessageTypes
func (x *ListTransferLogsRequest) GetMessageTypes() []TransferMessage_MessageSeverityfunc (*ListTransferLogsRequest) GetPageSize
func (x *ListTransferLogsRequest) GetPageSize() int32func (*ListTransferLogsRequest) GetPageToken
func (x *ListTransferLogsRequest) GetPageToken() stringfunc (*ListTransferLogsRequest) GetParent
func (x *ListTransferLogsRequest) GetParent() stringfunc (*ListTransferLogsRequest) ProtoMessage
func (*ListTransferLogsRequest) ProtoMessage()func (*ListTransferLogsRequest) ProtoReflect
func (x *ListTransferLogsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTransferLogsRequest) Reset
func (x *ListTransferLogsRequest) Reset()func (*ListTransferLogsRequest) String
func (x *ListTransferLogsRequest) String() stringListTransferLogsResponse
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
func (*ListTransferLogsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTransferLogsResponse.ProtoReflect.Descriptor instead.
func (*ListTransferLogsResponse) GetNextPageToken
func (x *ListTransferLogsResponse) GetNextPageToken() stringfunc (*ListTransferLogsResponse) GetTransferMessages
func (x *ListTransferLogsResponse) GetTransferMessages() []*TransferMessagefunc (*ListTransferLogsResponse) ProtoMessage
func (*ListTransferLogsResponse) ProtoMessage()func (*ListTransferLogsResponse) ProtoReflect
func (x *ListTransferLogsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTransferLogsResponse) Reset
func (x *ListTransferLogsResponse) Reset()func (*ListTransferLogsResponse) String
func (x *ListTransferLogsResponse) String() stringListTransferRunsRequest
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 `protobuf:"varint,2,rep,packed,name=states,proto3,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,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 `protobuf:"varint,5,opt,name=run_attempt,json=runAttempt,proto3,enum=google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest_RunAttempt" json:"run_attempt,omitempty"`
// contains filtered or unexported fields
}A request to list data transfer runs.
func (*ListTransferRunsRequest) Descriptor
func (*ListTransferRunsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTransferRunsRequest.ProtoReflect.Descriptor instead.
func (*ListTransferRunsRequest) GetPageSize
func (x *ListTransferRunsRequest) GetPageSize() int32func (*ListTransferRunsRequest) GetPageToken
func (x *ListTransferRunsRequest) GetPageToken() stringfunc (*ListTransferRunsRequest) GetParent
func (x *ListTransferRunsRequest) GetParent() stringfunc (*ListTransferRunsRequest) GetRunAttempt
func (x *ListTransferRunsRequest) GetRunAttempt() ListTransferRunsRequest_RunAttemptfunc (*ListTransferRunsRequest) GetStates
func (x *ListTransferRunsRequest) GetStates() []TransferStatefunc (*ListTransferRunsRequest) ProtoMessage
func (*ListTransferRunsRequest) ProtoMessage()func (*ListTransferRunsRequest) ProtoReflect
func (x *ListTransferRunsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTransferRunsRequest) Reset
func (x *ListTransferRunsRequest) Reset()func (*ListTransferRunsRequest) String
func (x *ListTransferRunsRequest) String() stringListTransferRunsRequest_RunAttempt
type ListTransferRunsRequest_RunAttempt int32Represents which runs should be pulled.
ListTransferRunsRequest_RUN_ATTEMPT_UNSPECIFIED, ListTransferRunsRequest_LATEST
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) Descriptor() protoreflect.EnumDescriptorfunc (ListTransferRunsRequest_RunAttempt) Enum
func (x ListTransferRunsRequest_RunAttempt) Enum() *ListTransferRunsRequest_RunAttemptfunc (ListTransferRunsRequest_RunAttempt) EnumDescriptor
func (ListTransferRunsRequest_RunAttempt) EnumDescriptor() ([]byte, []int)Deprecated: Use ListTransferRunsRequest_RunAttempt.Descriptor instead.
func (ListTransferRunsRequest_RunAttempt) Number
func (x ListTransferRunsRequest_RunAttempt) Number() protoreflect.EnumNumberfunc (ListTransferRunsRequest_RunAttempt) String
func (x ListTransferRunsRequest_RunAttempt) String() stringfunc (ListTransferRunsRequest_RunAttempt) Type
func (ListTransferRunsRequest_RunAttempt) Type() protoreflect.EnumTypeListTransferRunsResponse
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
func (*ListTransferRunsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTransferRunsResponse.ProtoReflect.Descriptor instead.
func (*ListTransferRunsResponse) GetNextPageToken
func (x *ListTransferRunsResponse) GetNextPageToken() stringfunc (*ListTransferRunsResponse) GetTransferRuns
func (x *ListTransferRunsResponse) GetTransferRuns() []*TransferRunfunc (*ListTransferRunsResponse) ProtoMessage
func (*ListTransferRunsResponse) ProtoMessage()func (*ListTransferRunsResponse) ProtoReflect
func (x *ListTransferRunsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTransferRunsResponse) Reset
func (x *ListTransferRunsResponse) Reset()func (*ListTransferRunsResponse) String
func (x *ListTransferRunsResponse) String() stringManualSchedule
type ManualSchedule struct {
// contains filtered or unexported fields
}Options customizing manual transfers schedule.
func (*ManualSchedule) Descriptor
func (*ManualSchedule) Descriptor() ([]byte, []int)Deprecated: Use ManualSchedule.ProtoReflect.Descriptor instead.
func (*ManualSchedule) ProtoMessage
func (*ManualSchedule) ProtoMessage()func (*ManualSchedule) ProtoReflect
func (x *ManualSchedule) ProtoReflect() protoreflect.Messagefunc (*ManualSchedule) Reset
func (x *ManualSchedule) Reset()func (*ManualSchedule) String
func (x *ManualSchedule) String() stringScheduleOptions
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 `protobuf:"varint,3,opt,name=disable_auto_scheduling,json=disableAutoScheduling,proto3" json:"disable_auto_scheduling,omitempty"`
// Specifies time to start scheduling transfer runs. The first run will be
// scheduled at or after the start time according to a recurrence pattern
// defined in the schedule string. The start time can be changed at any
// moment. The time when a data transfer can be triggered manually is not
// limited by this option.
StartTime *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 triggered 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
func (*ScheduleOptions) Descriptor() ([]byte, []int)Deprecated: Use ScheduleOptions.ProtoReflect.Descriptor instead.
func (*ScheduleOptions) GetDisableAutoScheduling
func (x *ScheduleOptions) GetDisableAutoScheduling() boolfunc (*ScheduleOptions) GetEndTime
func (x *ScheduleOptions) GetEndTime() *timestamppb.Timestampfunc (*ScheduleOptions) GetStartTime
func (x *ScheduleOptions) GetStartTime() *timestamppb.Timestampfunc (*ScheduleOptions) ProtoMessage
func (*ScheduleOptions) ProtoMessage()func (*ScheduleOptions) ProtoReflect
func (x *ScheduleOptions) ProtoReflect() protoreflect.Messagefunc (*ScheduleOptions) Reset
func (x *ScheduleOptions) Reset()func (*ScheduleOptions) String
func (x *ScheduleOptions) String() stringScheduleOptionsV2
type ScheduleOptionsV2 struct {
// Data transfer schedules.
//
// Types that are assignable to Schedule:
//
// *ScheduleOptionsV2_TimeBasedSchedule
// *ScheduleOptionsV2_ManualSchedule
// *ScheduleOptionsV2_EventDrivenSchedule
Schedule isScheduleOptionsV2_Schedule `protobuf_oneof:"schedule"`
// contains filtered or unexported fields
}V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
func (*ScheduleOptionsV2) Descriptor
func (*ScheduleOptionsV2) Descriptor() ([]byte, []int)Deprecated: Use ScheduleOptionsV2.ProtoReflect.Descriptor instead.
func (*ScheduleOptionsV2) GetEventDrivenSchedule
func (x *ScheduleOptionsV2) GetEventDrivenSchedule() *EventDrivenSchedulefunc (*ScheduleOptionsV2) GetManualSchedule
func (x *ScheduleOptionsV2) GetManualSchedule() *ManualSchedulefunc (*ScheduleOptionsV2) GetSchedule
func (m *ScheduleOptionsV2) GetSchedule() isScheduleOptionsV2_Schedulefunc (*ScheduleOptionsV2) GetTimeBasedSchedule
func (x *ScheduleOptionsV2) GetTimeBasedSchedule() *TimeBasedSchedulefunc (*ScheduleOptionsV2) ProtoMessage
func (*ScheduleOptionsV2) ProtoMessage()func (*ScheduleOptionsV2) ProtoReflect
func (x *ScheduleOptionsV2) ProtoReflect() protoreflect.Messagefunc (*ScheduleOptionsV2) Reset
func (x *ScheduleOptionsV2) Reset()func (*ScheduleOptionsV2) String
func (x *ScheduleOptionsV2) String() stringScheduleOptionsV2_EventDrivenSchedule
type ScheduleOptionsV2_EventDrivenSchedule struct {
// Event driven transfer schedule options. If set, the transfer will be
// scheduled upon events arrial.
EventDrivenSchedule *EventDrivenSchedule `protobuf:"bytes,3,opt,name=event_driven_schedule,json=eventDrivenSchedule,proto3,oneof"`
}ScheduleOptionsV2_ManualSchedule
type ScheduleOptionsV2_ManualSchedule struct {
// Manual transfer schedule. If set, the transfer run will not be
// auto-scheduled by the system, unless the client invokes
// StartManualTransferRuns. This is equivalent to
// disable_auto_scheduling = true.
ManualSchedule *ManualSchedule `protobuf:"bytes,2,opt,name=manual_schedule,json=manualSchedule,proto3,oneof"`
}ScheduleOptionsV2_TimeBasedSchedule
type ScheduleOptionsV2_TimeBasedSchedule struct {
// Time based transfer schedule options. This is the default schedule
// option.
TimeBasedSchedule *TimeBasedSchedule `protobuf:"bytes,1,opt,name=time_based_schedule,json=timeBasedSchedule,proto3,oneof"`
}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
func (*ScheduleTransferRunsRequest) Descriptor() ([]byte, []int)Deprecated: Use ScheduleTransferRunsRequest.ProtoReflect.Descriptor instead.
func (*ScheduleTransferRunsRequest) GetEndTime
func (x *ScheduleTransferRunsRequest) GetEndTime() *timestamppb.Timestampfunc (*ScheduleTransferRunsRequest) GetParent
func (x *ScheduleTransferRunsRequest) GetParent() stringfunc (*ScheduleTransferRunsRequest) GetStartTime
func (x *ScheduleTransferRunsRequest) GetStartTime() *timestamppb.Timestampfunc (*ScheduleTransferRunsRequest) ProtoMessage
func (*ScheduleTransferRunsRequest) ProtoMessage()func (*ScheduleTransferRunsRequest) ProtoReflect
func (x *ScheduleTransferRunsRequest) ProtoReflect() protoreflect.Messagefunc (*ScheduleTransferRunsRequest) Reset
func (x *ScheduleTransferRunsRequest) Reset()func (*ScheduleTransferRunsRequest) String
func (x *ScheduleTransferRunsRequest) String() stringScheduleTransferRunsResponse
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
func (*ScheduleTransferRunsResponse) Descriptor() ([]byte, []int)Deprecated: Use ScheduleTransferRunsResponse.ProtoReflect.Descriptor instead.
func (*ScheduleTransferRunsResponse) GetRuns
func (x *ScheduleTransferRunsResponse) GetRuns() []*TransferRunfunc (*ScheduleTransferRunsResponse) ProtoMessage
func (*ScheduleTransferRunsResponse) ProtoMessage()func (*ScheduleTransferRunsResponse) ProtoReflect
func (x *ScheduleTransferRunsResponse) ProtoReflect() protoreflect.Messagefunc (*ScheduleTransferRunsResponse) Reset
func (x *ScheduleTransferRunsResponse) Reset()func (*ScheduleTransferRunsResponse) String
func (x *ScheduleTransferRunsResponse) String() stringStartManualTransferRunsRequest
type StartManualTransferRunsRequest 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"`
// 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
func (*StartManualTransferRunsRequest) Descriptor() ([]byte, []int)Deprecated: Use StartManualTransferRunsRequest.ProtoReflect.Descriptor instead.
func (*StartManualTransferRunsRequest) GetParent
func (x *StartManualTransferRunsRequest) GetParent() stringfunc (*StartManualTransferRunsRequest) GetRequestedRunTime
func (x *StartManualTransferRunsRequest) GetRequestedRunTime() *timestamppb.Timestampfunc (*StartManualTransferRunsRequest) GetRequestedTimeRange
func (x *StartManualTransferRunsRequest) GetRequestedTimeRange() *StartManualTransferRunsRequest_TimeRangefunc (*StartManualTransferRunsRequest) GetTime
func (m *StartManualTransferRunsRequest) GetTime() isStartManualTransferRunsRequest_Timefunc (*StartManualTransferRunsRequest) ProtoMessage
func (*StartManualTransferRunsRequest) ProtoMessage()func (*StartManualTransferRunsRequest) ProtoReflect
func (x *StartManualTransferRunsRequest) ProtoReflect() protoreflect.Messagefunc (*StartManualTransferRunsRequest) Reset
func (x *StartManualTransferRunsRequest) Reset()func (*StartManualTransferRunsRequest) String
func (x *StartManualTransferRunsRequest) String() stringStartManualTransferRunsRequest_RequestedRunTime
type StartManualTransferRunsRequest_RequestedRunTime struct {
// A run_time timestamp for historical data files or reports
// that are scheduled to be transferred by the scheduled transfer run.
// requested_run_time must be a past time and cannot include future time
// values.
RequestedRunTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=requested_run_time,json=requestedRunTime,proto3,oneof"`
}StartManualTransferRunsRequest_RequestedTimeRange
type StartManualTransferRunsRequest_RequestedTimeRange struct {
// A time_range start and end timestamp for historical data files or reports
// that are scheduled to be transferred by the scheduled transfer run.
// requested_time_range must be a past time and cannot include future time
// values.
RequestedTimeRange *StartManualTransferRunsRequest_TimeRange `protobuf:"bytes,3,opt,name=requested_time_range,json=requestedTimeRange,proto3,oneof"`
}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
func (*StartManualTransferRunsRequest_TimeRange) Descriptor() ([]byte, []int)Deprecated: Use StartManualTransferRunsRequest_TimeRange.ProtoReflect.Descriptor instead.
func (*StartManualTransferRunsRequest_TimeRange) GetEndTime
func (x *StartManualTransferRunsRequest_TimeRange) GetEndTime() *timestamppb.Timestampfunc (*StartManualTransferRunsRequest_TimeRange) GetStartTime
func (x *StartManualTransferRunsRequest_TimeRange) GetStartTime() *timestamppb.Timestampfunc (*StartManualTransferRunsRequest_TimeRange) ProtoMessage
func (*StartManualTransferRunsRequest_TimeRange) ProtoMessage()func (*StartManualTransferRunsRequest_TimeRange) ProtoReflect
func (x *StartManualTransferRunsRequest_TimeRange) ProtoReflect() protoreflect.Messagefunc (*StartManualTransferRunsRequest_TimeRange) Reset
func (x *StartManualTransferRunsRequest_TimeRange) Reset()func (*StartManualTransferRunsRequest_TimeRange) String
func (x *StartManualTransferRunsRequest_TimeRange) String() stringStartManualTransferRunsResponse
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
func (*StartManualTransferRunsResponse) Descriptor() ([]byte, []int)Deprecated: Use StartManualTransferRunsResponse.ProtoReflect.Descriptor instead.
func (*StartManualTransferRunsResponse) GetRuns
func (x *StartManualTransferRunsResponse) GetRuns() []*TransferRunfunc (*StartManualTransferRunsResponse) ProtoMessage
func (*StartManualTransferRunsResponse) ProtoMessage()func (*StartManualTransferRunsResponse) ProtoReflect
func (x *StartManualTransferRunsResponse) ProtoReflect() protoreflect.Messagefunc (*StartManualTransferRunsResponse) Reset
func (x *StartManualTransferRunsResponse) Reset()func (*StartManualTransferRunsResponse) String
func (x *StartManualTransferRunsResponse) String() stringTimeBasedSchedule
type TimeBasedSchedule struct {
// 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,1,opt,name=schedule,proto3" json:"schedule,omitempty"`
// 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.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,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.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
func (*TimeBasedSchedule) Descriptor
func (*TimeBasedSchedule) Descriptor() ([]byte, []int)Deprecated: Use TimeBasedSchedule.ProtoReflect.Descriptor instead.
func (*TimeBasedSchedule) GetEndTime
func (x *TimeBasedSchedule) GetEndTime() *timestamppb.Timestampfunc (*TimeBasedSchedule) GetSchedule
func (x *TimeBasedSchedule) GetSchedule() stringfunc (*TimeBasedSchedule) GetStartTime
func (x *TimeBasedSchedule) GetStartTime() *timestamppb.Timestampfunc (*TimeBasedSchedule) ProtoMessage
func (*TimeBasedSchedule) ProtoMessage()func (*TimeBasedSchedule) ProtoReflect
func (x *TimeBasedSchedule) ProtoReflect() protoreflect.Messagefunc (*TimeBasedSchedule) Reset
func (x *TimeBasedSchedule) Reset()func (*TimeBasedSchedule) String
func (x *TimeBasedSchedule) String() stringTransferConfig
type TransferConfig struct {
// Identifier. The resource name of the transfer config.
// Transfer config names have the form either
// `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or
// `projects/{project_id}/transferConfigs/{config_id}`,
// where `config_id` is usually a UUID, even though it is not
// guaranteed or required. The name is ignored when creating a transfer
// config.
Name string `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"`
// Options customizing different types of data transfer schedule.
// This field replaces "schedule" and "schedule_options" fields.
// ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
ScheduleOptionsV2 *ScheduleOptionsV2 `protobuf:"bytes,31,opt,name=schedule_options_v2,json=scheduleOptionsV2,proto3" json:"schedule_options_v2,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,proto3" json:"data_refresh_window_days,omitempty"`
// Is this config disabled. When set to true, no runs will be scheduled for
// this transfer config.
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_id}/topics/{topic_id}`
NotificationPubsubTopic string `protobuf:"bytes,15,opt,name=notification_pubsub_topic,json=notificationPubsubTopic,proto3" json:"notification_pubsub_topic,omitempty"`
// 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"`
// The encryption configuration part. Currently, it is only used for the
// optional KMS key name. The BigQuery service account of your project must be
// granted permissions to use the key. Read methods will return the key name
// applied in effect. Write methods will apply the key if it is present, or
// otherwise try to apply project default keys if it is absent.
EncryptionConfiguration *EncryptionConfiguration `protobuf:"bytes,28,opt,name=encryption_configuration,json=encryptionConfiguration,proto3" json:"encryption_configuration,omitempty"`
// Output only. Error code with detailed information about reason of the
// latest config failure.
Error *status.Status `protobuf:"bytes,32,opt,name=error,proto3" json:"error,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
func (*TransferConfig) Descriptor() ([]byte, []int)Deprecated: Use TransferConfig.ProtoReflect.Descriptor instead.
func (*TransferConfig) GetDataRefreshWindowDays
func (x *TransferConfig) GetDataRefreshWindowDays() int32func (*TransferConfig) GetDataSourceId
func (x *TransferConfig) GetDataSourceId() stringfunc (*TransferConfig) GetDatasetRegion
func (x *TransferConfig) GetDatasetRegion() stringfunc (*TransferConfig) GetDestination
func (m *TransferConfig) GetDestination() isTransferConfig_Destinationfunc (*TransferConfig) GetDestinationDatasetId
func (x *TransferConfig) GetDestinationDatasetId() stringfunc (*TransferConfig) GetDisabled
func (x *TransferConfig) GetDisabled() boolfunc (*TransferConfig) GetDisplayName
func (x *TransferConfig) GetDisplayName() stringfunc (*TransferConfig) GetEmailPreferences
func (x *TransferConfig) GetEmailPreferences() *EmailPreferencesfunc (*TransferConfig) GetEncryptionConfiguration
func (x *TransferConfig) GetEncryptionConfiguration() *EncryptionConfigurationfunc (*TransferConfig) GetError
func (x *TransferConfig) GetError() *status.Statusfunc (*TransferConfig) GetName
func (x *TransferConfig) GetName() stringfunc (*TransferConfig) GetNextRunTime
func (x *TransferConfig) GetNextRunTime() *timestamppb.Timestampfunc (*TransferConfig) GetNotificationPubsubTopic
func (x *TransferConfig) GetNotificationPubsubTopic() stringfunc (*TransferConfig) GetOwnerInfo
func (x *TransferConfig) GetOwnerInfo() *UserInfofunc (*TransferConfig) GetParams
func (x *TransferConfig) GetParams() *structpb.Structfunc (*TransferConfig) GetSchedule
func (x *TransferConfig) GetSchedule() stringfunc (*TransferConfig) GetScheduleOptions
func (x *TransferConfig) GetScheduleOptions() *ScheduleOptionsfunc (*TransferConfig) GetScheduleOptionsV2
func (x *TransferConfig) GetScheduleOptionsV2() *ScheduleOptionsV2func (*TransferConfig) GetState
func (x *TransferConfig) GetState() TransferStatefunc (*TransferConfig) GetUpdateTime
func (x *TransferConfig) GetUpdateTime() *timestamppb.Timestampfunc (*TransferConfig) GetUserId
func (x *TransferConfig) GetUserId() int64func (*TransferConfig) ProtoMessage
func (*TransferConfig) ProtoMessage()func (*TransferConfig) ProtoReflect
func (x *TransferConfig) ProtoReflect() protoreflect.Messagefunc (*TransferConfig) Reset
func (x *TransferConfig) Reset()func (*TransferConfig) String
func (x *TransferConfig) String() stringTransferConfig_DestinationDatasetId
type TransferConfig_DestinationDatasetId struct {
// The BigQuery target dataset id.
DestinationDatasetId string `protobuf:"bytes,2,opt,name=destination_dataset_id,json=destinationDatasetId,proto3,oneof"`
}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 `protobuf:"varint,2,opt,name=severity,proto3,enum=google.cloud.bigquery.datatransfer.v1.TransferMessage_MessageSeverity" json:"severity,omitempty"`
// 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
func (*TransferMessage) Descriptor() ([]byte, []int)Deprecated: Use TransferMessage.ProtoReflect.Descriptor instead.
func (*TransferMessage) GetMessageText
func (x *TransferMessage) GetMessageText() stringfunc (*TransferMessage) GetMessageTime
func (x *TransferMessage) GetMessageTime() *timestamppb.Timestampfunc (*TransferMessage) GetSeverity
func (x *TransferMessage) GetSeverity() TransferMessage_MessageSeverityfunc (*TransferMessage) ProtoMessage
func (*TransferMessage) ProtoMessage()func (*TransferMessage) ProtoReflect
func (x *TransferMessage) ProtoReflect() protoreflect.Messagefunc (*TransferMessage) Reset
func (x *TransferMessage) Reset()func (*TransferMessage) String
func (x *TransferMessage) String() stringTransferMessage_MessageSeverity
type TransferMessage_MessageSeverity int32Represents data transfer user facing message severity.
TransferMessage_MESSAGE_SEVERITY_UNSPECIFIED, TransferMessage_INFO, TransferMessage_WARNING, TransferMessage_ERROR
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) Descriptor() protoreflect.EnumDescriptorfunc (TransferMessage_MessageSeverity) Enum
func (x TransferMessage_MessageSeverity) Enum() *TransferMessage_MessageSeverityfunc (TransferMessage_MessageSeverity) EnumDescriptor
func (TransferMessage_MessageSeverity) EnumDescriptor() ([]byte, []int)Deprecated: Use TransferMessage_MessageSeverity.Descriptor instead.
func (TransferMessage_MessageSeverity) Number
func (x TransferMessage_MessageSeverity) Number() protoreflect.EnumNumberfunc (TransferMessage_MessageSeverity) String
func (x TransferMessage_MessageSeverity) String() stringfunc (TransferMessage_MessageSeverity) Type
func (TransferMessage_MessageSeverity) Type() protoreflect.EnumTypeTransferRun
type TransferRun struct {
// Identifier. The resource name of the transfer run.
// Transfer run names have the form
// `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
// The name is ignored when creating a transfer run.
Name string `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_id}/topics/{topic_id}`
NotificationPubsubTopic string `protobuf:"bytes,23,opt,name=notification_pubsub_topic,json=notificationPubsubTopic,proto3" json:"notification_pubsub_topic,omitempty"`
// 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
func (*TransferRun) Descriptor() ([]byte, []int)Deprecated: Use TransferRun.ProtoReflect.Descriptor instead.
func (*TransferRun) GetDataSourceId
func (x *TransferRun) GetDataSourceId() stringfunc (*TransferRun) GetDestination
func (m *TransferRun) GetDestination() isTransferRun_Destinationfunc (*TransferRun) GetDestinationDatasetId
func (x *TransferRun) GetDestinationDatasetId() stringfunc (*TransferRun) GetEmailPreferences
func (x *TransferRun) GetEmailPreferences() *EmailPreferencesfunc (*TransferRun) GetEndTime
func (x *TransferRun) GetEndTime() *timestamppb.Timestampfunc (*TransferRun) GetErrorStatus
func (x *TransferRun) GetErrorStatus() *status.Statusfunc (*TransferRun) GetName
func (x *TransferRun) GetName() stringfunc (*TransferRun) GetNotificationPubsubTopic
func (x *TransferRun) GetNotificationPubsubTopic() stringfunc (*TransferRun) GetParams
func (x *TransferRun) GetParams() *structpb.Structfunc (*TransferRun) GetRunTime
func (x *TransferRun) GetRunTime() *timestamppb.Timestampfunc (*TransferRun) GetSchedule
func (x *TransferRun) GetSchedule() stringfunc (*TransferRun) GetScheduleTime
func (x *TransferRun) GetScheduleTime() *timestamppb.Timestampfunc (*TransferRun) GetStartTime
func (x *TransferRun) GetStartTime() *timestamppb.Timestampfunc (*TransferRun) GetState
func (x *TransferRun) GetState() TransferStatefunc (*TransferRun) GetUpdateTime
func (x *TransferRun) GetUpdateTime() *timestamppb.Timestampfunc (*TransferRun) GetUserId
func (x *TransferRun) GetUserId() int64func (*TransferRun) ProtoMessage
func (*TransferRun) ProtoMessage()func (*TransferRun) ProtoReflect
func (x *TransferRun) ProtoReflect() protoreflect.Messagefunc (*TransferRun) Reset
func (x *TransferRun) Reset()func (*TransferRun) String
func (x *TransferRun) String() stringTransferRun_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"`
}TransferState
type TransferState int32Represents data transfer run state.
TransferState_TRANSFER_STATE_UNSPECIFIED, TransferState_PENDING, TransferState_RUNNING, TransferState_SUCCEEDED, TransferState_FAILED, TransferState_CANCELLED
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) Descriptor() protoreflect.EnumDescriptorfunc (TransferState) Enum
func (x TransferState) Enum() *TransferStatefunc (TransferState) EnumDescriptor
func (TransferState) EnumDescriptor() ([]byte, []int)Deprecated: Use TransferState.Descriptor instead.
func (TransferState) Number
func (x TransferState) Number() protoreflect.EnumNumberfunc (TransferState) String
func (x TransferState) String() stringfunc (TransferState) Type
func (TransferState) Type() protoreflect.EnumTypeTransferType (deprecated)
type TransferType int32DEPRECATED. Represents data transfer type.
Deprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/transfer.proto.
TransferType_TRANSFER_TYPE_UNSPECIFIED, TransferType_BATCH, TransferType_STREAMING (deprecated)
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 (deprecated)
func (TransferType) Descriptor() protoreflect.EnumDescriptorfunc (TransferType) Enum (deprecated)
func (x TransferType) Enum() *TransferTypefunc (TransferType) EnumDescriptor (deprecated)
func (TransferType) EnumDescriptor() ([]byte, []int)Deprecated: Use TransferType.Descriptor instead.
func (TransferType) Number (deprecated)
func (x TransferType) Number() protoreflect.EnumNumberfunc (TransferType) String (deprecated)
func (x TransferType) String() stringfunc (TransferType) Type (deprecated)
func (TransferType) Type() protoreflect.EnumTypeUnenrollDataSourcesRequest
type UnenrollDataSourcesRequest struct {
// Required. 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 unenrolled. 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 unenroll a set of data sources so they are no longer visible in
the BigQuery UI's Transfer tab.
func (*UnenrollDataSourcesRequest) Descriptor
func (*UnenrollDataSourcesRequest) Descriptor() ([]byte, []int)Deprecated: Use UnenrollDataSourcesRequest.ProtoReflect.Descriptor instead.
func (*UnenrollDataSourcesRequest) GetDataSourceIds
func (x *UnenrollDataSourcesRequest) GetDataSourceIds() []stringfunc (*UnenrollDataSourcesRequest) GetName
func (x *UnenrollDataSourcesRequest) GetName() stringfunc (*UnenrollDataSourcesRequest) ProtoMessage
func (*UnenrollDataSourcesRequest) ProtoMessage()func (*UnenrollDataSourcesRequest) ProtoReflect
func (x *UnenrollDataSourcesRequest) ProtoReflect() protoreflect.Messagefunc (*UnenrollDataSourcesRequest) Reset
func (x *UnenrollDataSourcesRequest) Reset()func (*UnenrollDataSourcesRequest) String
func (x *UnenrollDataSourcesRequest) String() stringUnimplementedDataTransferServiceServer
type UnimplementedDataTransferServiceServer struct {
}UnimplementedDataTransferServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedDataTransferServiceServer) CheckValidCreds
func (UnimplementedDataTransferServiceServer) CheckValidCreds(context.Context, *CheckValidCredsRequest) (*CheckValidCredsResponse, error)func (UnimplementedDataTransferServiceServer) CreateTransferConfig
func (UnimplementedDataTransferServiceServer) CreateTransferConfig(context.Context, *CreateTransferConfigRequest) (*TransferConfig, error)func (UnimplementedDataTransferServiceServer) DeleteTransferConfig
func (UnimplementedDataTransferServiceServer) DeleteTransferConfig(context.Context, *DeleteTransferConfigRequest) (*emptypb.Empty, error)func (UnimplementedDataTransferServiceServer) DeleteTransferRun
func (UnimplementedDataTransferServiceServer) DeleteTransferRun(context.Context, *DeleteTransferRunRequest) (*emptypb.Empty, error)func (UnimplementedDataTransferServiceServer) EnrollDataSources
func (UnimplementedDataTransferServiceServer) EnrollDataSources(context.Context, *EnrollDataSourcesRequest) (*emptypb.Empty, error)func (UnimplementedDataTransferServiceServer) GetDataSource
func (UnimplementedDataTransferServiceServer) GetDataSource(context.Context, *GetDataSourceRequest) (*DataSource, error)func (UnimplementedDataTransferServiceServer) GetTransferConfig
func (UnimplementedDataTransferServiceServer) GetTransferConfig(context.Context, *GetTransferConfigRequest) (*TransferConfig, error)func (UnimplementedDataTransferServiceServer) GetTransferRun
func (UnimplementedDataTransferServiceServer) GetTransferRun(context.Context, *GetTransferRunRequest) (*TransferRun, error)func (UnimplementedDataTransferServiceServer) ListDataSources
func (UnimplementedDataTransferServiceServer) ListDataSources(context.Context, *ListDataSourcesRequest) (*ListDataSourcesResponse, error)func (UnimplementedDataTransferServiceServer) ListTransferConfigs
func (UnimplementedDataTransferServiceServer) ListTransferConfigs(context.Context, *ListTransferConfigsRequest) (*ListTransferConfigsResponse, error)func (UnimplementedDataTransferServiceServer) ListTransferLogs
func (UnimplementedDataTransferServiceServer) ListTransferLogs(context.Context, *ListTransferLogsRequest) (*ListTransferLogsResponse, error)func (UnimplementedDataTransferServiceServer) ListTransferRuns
func (UnimplementedDataTransferServiceServer) ListTransferRuns(context.Context, *ListTransferRunsRequest) (*ListTransferRunsResponse, error)func (UnimplementedDataTransferServiceServer) ScheduleTransferRuns
func (UnimplementedDataTransferServiceServer) ScheduleTransferRuns(context.Context, *ScheduleTransferRunsRequest) (*ScheduleTransferRunsResponse, error)func (UnimplementedDataTransferServiceServer) StartManualTransferRuns
func (UnimplementedDataTransferServiceServer) StartManualTransferRuns(context.Context, *StartManualTransferRunsRequest) (*StartManualTransferRunsResponse, error)func (UnimplementedDataTransferServiceServer) UnenrollDataSources
func (UnimplementedDataTransferServiceServer) UnenrollDataSources(context.Context, *UnenrollDataSourcesRequest) (*emptypb.Empty, error)func (UnimplementedDataTransferServiceServer) UpdateTransferConfig
func (UnimplementedDataTransferServiceServer) UpdateTransferConfig(context.Context, *UpdateTransferConfigRequest) (*TransferConfig, error)UnsafeDataTransferServiceServer
type UnsafeDataTransferServiceServer interface {
// contains filtered or unexported methods
}UnsafeDataTransferServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataTransferServiceServer will result in compilation errors.
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"`
// Deprecated: Authorization code was required when
// `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used
// in any data sources. Use `version_info` instead.
//
// Optional OAuth2 authorization code to use with this transfer configuration.
// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
// and new credentials are needed, as indicated by `CheckValidCreds`. In order
// to obtain authorization_code, make a request to the following URL:
// // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
// // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes //
A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
When using a cross project service account for updating a transfer config, you must enable cross project service account usage. For more information, see Disable attachment of service accounts to resources in other projects.
func (*UpdateTransferConfigRequest) Descriptor
func (*UpdateTransferConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateTransferConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateTransferConfigRequest) GetAuthorizationCode
func (x *UpdateTransferConfigRequest) GetAuthorizationCode() stringDeprecated: Marked as deprecated in google/cloud/bigquery/datatransfer/v1/datatransfer.proto.
func (*UpdateTransferConfigRequest) GetServiceAccountName
func (x *UpdateTransferConfigRequest) GetServiceAccountName() stringfunc (*UpdateTransferConfigRequest) GetTransferConfig
func (x *UpdateTransferConfigRequest) GetTransferConfig() *TransferConfigfunc (*UpdateTransferConfigRequest) GetUpdateMask
func (x *UpdateTransferConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateTransferConfigRequest) GetVersionInfo
func (x *UpdateTransferConfigRequest) GetVersionInfo() stringfunc (*UpdateTransferConfigRequest) ProtoMessage
func (*UpdateTransferConfigRequest) ProtoMessage()func (*UpdateTransferConfigRequest) ProtoReflect
func (x *UpdateTransferConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateTransferConfigRequest) Reset
func (x *UpdateTransferConfigRequest) Reset()func (*UpdateTransferConfigRequest) String
func (x *UpdateTransferConfigRequest) String() stringUserInfo
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: Use UserInfo.ProtoReflect.Descriptor instead.
func (*UserInfo) GetEmail
func (*UserInfo) ProtoMessage
func (*UserInfo) ProtoMessage()func (*UserInfo) ProtoReflect
func (x *UserInfo) ProtoReflect() protoreflect.Messagefunc (*UserInfo) Reset
func (x *UserInfo) Reset()