Class: Google::Shopping::Merchant::DataSources::V1beta::FileUpload

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb

Overview

The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources.

Defined Under Namespace

Modules: ProcessingState Classes: Issue

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_id ⇒ ::Integer (readonly)

Returns Output only. The data source id.

Returns:

  • (::Integer) —

    Output only. The data source id.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#issues ⇒ ::Array<::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue> (readonly)

Returns Output only. The list of issues occurring in the data source.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#items_created ⇒ ::Integer (readonly)

Returns Output only. The number of items in the data source that were created.

Returns:

  • (::Integer) —

    Output only. The number of items in the data source that were created.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#items_total ⇒ ::Integer (readonly)

Returns Output only. The number of items in the data source that were processed.

Returns:

  • (::Integer) —

    Output only. The number of items in the data source that were processed.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#items_updated ⇒ ::Integer (readonly)

Returns Output only. The number of items in the data source that were updated.

Returns:

  • (::Integer) —

    Output only. The number of items in the data source that were updated.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#name ⇒ ::String

Returns Identifier. The name of the data source file upload. Format: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}.

Returns:

  • (::String) —

    Identifier. The name of the data source file upload. Format: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#processing_state ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::ProcessingState (readonly)

Returns Output only. The processing state of the data source.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end

#upload_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The date at which the file of the data source was uploaded.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileuploads.rb', line 55

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

  # An error occurring in the data source, like "invalid price".
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the issue, for example, "Item too big".
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. The error description, for example, "Your data source
  #     contains items which have too many attributes, or are too big. These
  #     items will be dropped".
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The code of the error, for example,
  #     "validation/invalid_value". Returns
  #     "?" if the code is unknown.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. The number of occurrences of the error in the file upload.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileUpload::Issue::Severity]
  #     Output only. The severity of the issue.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. Link to the documentation explaining the issue in more
  #     details, if available.
  class Issue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Severity unspecified.
      SEVERITY_UNSPECIFIED = 0

      # The issue is the warning.
      WARNING = 1

      # The issue is an error.
      ERROR = 2
    end
  end

  # The processing state of the data source.
  module ProcessingState
    # Processing state unspecified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The data source could not be processed or all the items had errors.
    FAILED = 1

    # The data source is being processed.
    IN_PROGRESS = 2

    # The data source was processed successfully, though some items might have
    # had errors.
    SUCCEEDED = 3
  end
end