Represents a FetchSettings.
Package
@google-shopping/datasourcesConstructors
(constructor)(properties)
constructor(properties?: google.shopping.merchant.datasources.v1beta.FileInput.IFetchSettings);Constructs a new FetchSettings.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFetchSettings
Properties to set |
Properties
dayOfMonth
public dayOfMonth: number;FetchSettings dayOfMonth.
dayOfWeek
public dayOfWeek: (google.type.DayOfWeek|keyof typeof google.type.DayOfWeek);FetchSettings dayOfWeek.
enabled
public enabled: boolean;FetchSettings enabled.
fetchUri
public fetchUri: string;FetchSettings fetchUri.
frequency
public frequency: (google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency|keyof typeof google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings.Frequency);FetchSettings frequency.
password
public password: string;FetchSettings password.
timeOfDay
public timeOfDay?: (google.type.ITimeOfDay|null);FetchSettings timeOfDay.
timeZone
public timeZone: string;FetchSettings timeZone.
username
public username: string;FetchSettings username.
Methods
create(properties)
public static create(properties?: google.shopping.merchant.datasources.v1beta.FileInput.IFetchSettings): google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings;Creates a new FetchSettings instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFetchSettings
Properties to set |
| Returns | |
|---|---|
| Type | Description |
FetchSettings |
FetchSettings instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings;Decodes a FetchSettings message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
FetchSettings |
FetchSettings |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings;Decodes a FetchSettings message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FetchSettings |
FetchSettings |
encode(message, writer)
public static encode(message: google.shopping.merchant.datasources.v1beta.FileInput.IFetchSettings, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FetchSettings message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFetchSettings
FetchSettings message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.shopping.merchant.datasources.v1beta.FileInput.IFetchSettings, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FetchSettings message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFetchSettings
FetchSettings message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings;Creates a FetchSettings message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
FetchSettings |
FetchSettings |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for FetchSettings
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this FetchSettings to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.merchant.datasources.v1beta.FileInput.FetchSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a FetchSettings message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
FetchSettings
FetchSettings |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a FetchSettings message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|