Interface FileInput.FetchSettingsOrBuilder (0.3.0)

public static interface FileInput.FetchSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDayOfMonth()

public abstract 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 abstract 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 abstract 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.

getEnabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getTimeOfDayOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.