Class FileInput.FetchSettings.Builder (0.11.0)

public static final class FileInput.FetchSettings.Builder extends GeneratedMessageV3.Builder<FileInput.FetchSettings.Builder> implements FileInput.FetchSettingsOrBuilder

Fetch details to deliver the data source.

Protobuf type google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FileInput.FetchSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

build()

public FileInput.FetchSettings build()
Returns
Type Description
FileInput.FetchSettings

buildPartial()

public FileInput.FetchSettings buildPartial()
Returns
Type Description
FileInput.FetchSettings

clear()

public FileInput.FetchSettings.Builder clear()
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

clearDayOfMonth()

public FileInput.FetchSettings.Builder clearDayOfMonth()

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.

int32 day_of_month = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearDayOfWeek()

public FileInput.FetchSettings.Builder clearDayOfWeek()

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

.google.type.DayOfWeek day_of_week = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearEnabled()

public FileInput.FetchSettings.Builder clearEnabled()

Optional. Enables or pauses the fetch schedule.

bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearFetchUri()

public FileInput.FetchSettings.Builder clearFetchUri()

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.

string fetch_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FileInput.FetchSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

clearFrequency()

public FileInput.FetchSettings.Builder clearFrequency()

Required. The frequency describing fetch schedule.

.google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency frequency = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FileInput.FetchSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

clearPassword()

public FileInput.FetchSettings.Builder clearPassword()

Optional. An optional password for fetch url. Used for submitting data sources through SFTP.

string password = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearTimeOfDay()

public FileInput.FetchSettings.Builder clearTimeOfDay()

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

clearTimeZone()

public FileInput.FetchSettings.Builder clearTimeZone()

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

string time_zone = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clearUsername()

public FileInput.FetchSettings.Builder clearUsername()

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP.

string username = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

clone()

public FileInput.FetchSettings.Builder clone()
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

getDayOfMonth()

public int getDayOfMonth()

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.

int32 day_of_month = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The dayOfMonth.

getDayOfWeek()

public DayOfWeek getDayOfWeek()

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

.google.type.DayOfWeek day_of_week = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DayOfWeek

The dayOfWeek.

getDayOfWeekValue()

public int getDayOfWeekValue()

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

.google.type.DayOfWeek day_of_week = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for dayOfWeek.

getDefaultInstanceForType()

public FileInput.FetchSettings getDefaultInstanceForType()
Returns
Type Description
FileInput.FetchSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnabled()

public boolean getEnabled()

Optional. Enables or pauses the fetch schedule.

bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enabled.

getFetchUri()

public String getFetchUri()

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.

string fetch_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The fetchUri.

getFetchUriBytes()

public ByteString getFetchUriBytes()

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.

string fetch_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for fetchUri.

getFrequency()

public FileInput.FetchSettings.Frequency getFrequency()

Required. The frequency describing fetch schedule.

.google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency frequency = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FileInput.FetchSettings.Frequency

The frequency.

getFrequencyValue()

public int getFrequencyValue()

Required. The frequency describing fetch schedule.

.google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency frequency = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for frequency.

getPassword()

public String getPassword()

Optional. An optional password for fetch url. Used for submitting data sources through SFTP.

string password = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The password.

getPasswordBytes()

public ByteString getPasswordBytes()

Optional. An optional password for fetch url. Used for submitting data sources through SFTP.

string password = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for password.

getTimeOfDay()

public TimeOfDay getTimeOfDay()

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.TimeOfDay

The timeOfDay.

getTimeOfDayBuilder()

public TimeOfDay.Builder getTimeOfDayBuilder()

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.TimeOfDay.Builder

getTimeOfDayOrBuilder()

public TimeOfDayOrBuilder getTimeOfDayOrBuilder()

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.TimeOfDayOrBuilder

getTimeZone()

public String getTimeZone()

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

string time_zone = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

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

string time_zone = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for timeZone.

getUsername()

public String getUsername()

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP.

string username = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The username.

getUsernameBytes()

public ByteString getUsernameBytes()

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP.

string username = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for username.

hasTimeOfDay()

public boolean hasTimeOfDay()

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the timeOfDay field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FileInput.FetchSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FileInput.FetchSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

mergeFrom(FileInput.FetchSettings other)

public FileInput.FetchSettings.Builder mergeFrom(FileInput.FetchSettings other)
Parameter
Name Description
other FileInput.FetchSettings
Returns
Type Description
FileInput.FetchSettings.Builder

mergeTimeOfDay(TimeOfDay value)

public FileInput.FetchSettings.Builder mergeTimeOfDay(TimeOfDay value)

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
FileInput.FetchSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FileInput.FetchSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

setDayOfMonth(int value)

public FileInput.FetchSettings.Builder setDayOfMonth(int value)

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.

int32 day_of_month = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The dayOfMonth to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setDayOfWeek(DayOfWeek value)

public FileInput.FetchSettings.Builder setDayOfWeek(DayOfWeek value)

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

.google.type.DayOfWeek day_of_week = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.type.DayOfWeek

The dayOfWeek to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setDayOfWeekValue(int value)

public FileInput.FetchSettings.Builder setDayOfWeekValue(int value)

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

.google.type.DayOfWeek day_of_week = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for dayOfWeek to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setEnabled(boolean value)

public FileInput.FetchSettings.Builder setEnabled(boolean value)

Optional. Enables or pauses the fetch schedule.

bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setFetchUri(String value)

public FileInput.FetchSettings.Builder setFetchUri(String value)

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.

string fetch_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The fetchUri to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setFetchUriBytes(ByteString value)

public FileInput.FetchSettings.Builder setFetchUriBytes(ByteString value)

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.

string fetch_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for fetchUri to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FileInput.FetchSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

setFrequency(FileInput.FetchSettings.Frequency value)

public FileInput.FetchSettings.Builder setFrequency(FileInput.FetchSettings.Frequency value)

Required. The frequency describing fetch schedule.

.google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency frequency = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FileInput.FetchSettings.Frequency

The frequency to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setFrequencyValue(int value)

public FileInput.FetchSettings.Builder setFrequencyValue(int value)

Required. The frequency describing fetch schedule.

.google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency frequency = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for frequency to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setPassword(String value)

public FileInput.FetchSettings.Builder setPassword(String value)

Optional. An optional password for fetch url. Used for submitting data sources through SFTP.

string password = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The password to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setPasswordBytes(ByteString value)

public FileInput.FetchSettings.Builder setPasswordBytes(ByteString value)

Optional. An optional password for fetch url. Used for submitting data sources through SFTP.

string password = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for password to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FileInput.FetchSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

setTimeOfDay(TimeOfDay value)

public FileInput.FetchSettings.Builder setTimeOfDay(TimeOfDay value)

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
FileInput.FetchSettings.Builder

setTimeOfDay(TimeOfDay.Builder builderForValue)

public FileInput.FetchSettings.Builder setTimeOfDay(TimeOfDay.Builder builderForValue)

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

.google.type.TimeOfDay time_of_day = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue com.google.type.TimeOfDay.Builder
Returns
Type Description
FileInput.FetchSettings.Builder

setTimeZone(String value)

public FileInput.FetchSettings.Builder setTimeZone(String value)

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

string time_zone = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The timeZone to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public FileInput.FetchSettings.Builder setTimeZoneBytes(ByteString value)

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

string time_zone = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for timeZone to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FileInput.FetchSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

setUsername(String value)

public FileInput.FetchSettings.Builder setUsername(String value)

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP.

string username = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The username to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.

setUsernameBytes(ByteString value)

public FileInput.FetchSettings.Builder setUsernameBytes(ByteString value)

Optional. An optional user name for fetch url. Used for submitting data sources through SFTP.

string username = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for username to set.

Returns
Type Description
FileInput.FetchSettings.Builder

This builder for chaining.