Class: Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings

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

Overview

Fetch details to deliver the data source.

Defined Under Namespace

Modules: Frequency

Instance Attribute Summary collapse

Instance Attribute Details

#day_of_month ⇒ ::Integer

Returns Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.

Returns:

  • (::Integer) —

    Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#day_of_week ⇒ ::Google::Type::DayOfWeek

Returns Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.

Returns:

  • (::Google::Type::DayOfWeek) —

    Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#enabled ⇒ ::Boolean

Returns Optional. Enables or pauses the fetch schedule.

Returns:

  • (::Boolean) —

    Optional. Enables or pauses the fetch schedule.



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#fetch_uri ⇒ ::String

Returns Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.

Returns:

  • (::String) —

    Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#frequency ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings::Frequency

Returns Required. The frequency describing fetch schedule.

Returns:



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#password ⇒ ::String

Returns Optional. An optional password for fetch_uri. Used for submitting data sources through SFTP.

Returns:



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#time_of_day ⇒ ::Google::Type::TimeOfDay

Returns Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.

Returns:

  • (::Google::Type::TimeOfDay) —

    Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#time_zone ⇒ ::String

Returns Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".

Returns:

  • (::String) —

    Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end

#username ⇒ ::String

Returns Optional. An optional user name for fetch_uri. Used for submitting data sources through SFTP.

Returns:



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
116
117
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 84

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

  # The required fields vary based on the frequency of fetching. For a
  # monthly
  # fetch schedule,
  # [day of
  # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
  # and
  # [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a weekly fetch schedule,
  # [day of
  # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
  # and [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # are required. For a daily fetch schedule, only an [hour of
  # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
  # is required.
  module Frequency
    # Frequency unspecified.
    FREQUENCY_UNSPECIFIED = 0

    # The fetch happens every day.
    FREQUENCY_DAILY = 1

    # The fetch happens every week.
    FREQUENCY_WEEKLY = 2

    # The fetch happens every month.
    FREQUENCY_MONTHLY = 3
  end
end