Class: Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb

Overview

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

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_values ⇒ ::Array<::String>

Returns All possible values for the parameter.

Returns:

  • (::Array<::String>) —

    All possible values for the parameter.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#deprecated ⇒ ::Boolean

Returns If true, it should not be used in new transfers, and it should not be visible to users.

Returns:

  • (::Boolean) —

    If true, it should not be used in new transfers, and it should not be visible to users.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#description ⇒ ::String

Returns Parameter description.

Returns:

  • (::String) —

    Parameter description.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#display_name ⇒ ::String

Returns Parameter display name in the user interface.

Returns:

  • (::String) —

    Parameter display name in the user interface.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#fields ⇒ ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>

Returns Deprecated. This field has no effect.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#immutable ⇒ ::Boolean

Returns Cannot be changed after initial creation.

Returns:

  • (::Boolean) —

    Cannot be changed after initial creation.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#max_value ⇒ ::Google::Protobuf::DoubleValue

Returns For integer and double values specifies maximum allowed value.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#min_value ⇒ ::Google::Protobuf::DoubleValue

Returns For integer and double values specifies minimum allowed value.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#param_id ⇒ ::String

Returns Parameter identifier.

Returns:

  • (::String) —

    Parameter identifier.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#recurse ⇒ ::Boolean

Returns Deprecated. This field has no effect.

Returns:

  • (::Boolean) —

    Deprecated. This field has no effect.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#repeated ⇒ ::Boolean

Returns Deprecated. This field has no effect.

Returns:

  • (::Boolean) —

    Deprecated. This field has no effect.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#required ⇒ ::Boolean

Returns Is parameter required.

Returns:

  • (::Boolean) —

    Is parameter required.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#type ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type

Returns Parameter type.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#validation_description ⇒ ::String

Returns Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

Returns:

  • (::String) —

    Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#validation_help_url ⇒ ::String

Returns URL to a help document to further explain the naming requirements.

Returns:

  • (::String) —

    URL to a help document to further explain the naming requirements.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end

#validation_regex ⇒ ::String

Returns Regular expression which can be used for parameter validation.

Returns:

  • (::String) —

    Regular expression which can be used for parameter validation.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 76

class DataSourceParameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Deprecated. This field has no effect.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6

    # List of strings parameter.
    LIST = 7
  end
end