Class FileInput.FetchSettings (0.11.0)

public static final class FileInput.FetchSettings extends GeneratedMessageV3 implements FileInput.FetchSettingsOrBuilder

Fetch details to deliver the data source.

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

Static Fields

DAY_OF_MONTH_FIELD_NUMBER

public static final int DAY_OF_MONTH_FIELD_NUMBER
Field Value
Type Description
int

DAY_OF_WEEK_FIELD_NUMBER

public static final int DAY_OF_WEEK_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

FETCH_URI_FIELD_NUMBER

public static final int FETCH_URI_FIELD_NUMBER
Field Value
Type Description
int

FREQUENCY_FIELD_NUMBER

public static final int FREQUENCY_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

TIME_OF_DAY_FIELD_NUMBER

public static final int TIME_OF_DAY_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FileInput.FetchSettings getDefaultInstance()
Returns
Type Description
FileInput.FetchSettings

getDescriptor()

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

newBuilder()

public static FileInput.FetchSettings.Builder newBuilder()
Returns
Type Description
FileInput.FetchSettings.Builder

newBuilder(FileInput.FetchSettings prototype)

public static FileInput.FetchSettings.Builder newBuilder(FileInput.FetchSettings prototype)
Parameter
Name Description
prototype FileInput.FetchSettings
Returns
Type Description
FileInput.FetchSettings.Builder

parseDelimitedFrom(InputStream input)

public static FileInput.FetchSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FileInput.FetchSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FileInput.FetchSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FileInput.FetchSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FileInput.FetchSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FileInput.FetchSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FileInput.FetchSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileInput.FetchSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FileInput.FetchSettings> parser()
Returns
Type Description
Parser<FetchSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<FileInput.FetchSettings> getParserForType()
Returns
Type Description
Parser<FetchSettings>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FileInput.FetchSettings.Builder newBuilderForType()
Returns
Type Description
FileInput.FetchSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FileInput.FetchSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FileInput.FetchSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FileInput.FetchSettings.Builder toBuilder()
Returns
Type Description
FileInput.FetchSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException