DatafeedFetchSchedule (Content API for Shopping v2.1-rev20240325-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.content.model.DatafeedFetchSchedule

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class DatafeedFetchSchedule
extends com.google.api.client.json.GenericJson
```
The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

DatafeedFetchSchedule()

Constructors
Constructor and Description
`DatafeedFetchSchedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatafeedFetchSchedule`	`clone()`
`Long`	`getDayOfMonth()` The day of the month the feed file should be fetched (1-31).
`String`	`getFetchUrl()` The URL where the feed file can be fetched.
`Long`	`getHour()` The hour of the day the feed file should be fetched (0-23).
`Long`	`getMinuteOfHour()` The minute of the hour the feed file should be fetched (0-59).
`String`	`getPassword()` An optional password for fetch_url.
`Boolean`	`getPaused()` Whether the scheduled fetch is paused or not.
`String`	`getTimeZone()` Time zone used for schedule.
`String`	`getUsername()` An optional user name for fetch_url.
`String`	`getWeekday()` The day of the week the feed file should be fetched.
`DatafeedFetchSchedule`	`set(String fieldName, Object value)`
`DatafeedFetchSchedule`	`setDayOfMonth(Long dayOfMonth)` The day of the month the feed file should be fetched (1-31).
`DatafeedFetchSchedule`	`setFetchUrl(String fetchUrl)` The URL where the feed file can be fetched.
`DatafeedFetchSchedule`	`setHour(Long hour)` The hour of the day the feed file should be fetched (0-23).
`DatafeedFetchSchedule`	`setMinuteOfHour(Long minuteOfHour)` The minute of the hour the feed file should be fetched (0-59).
`DatafeedFetchSchedule`	`setPassword(String password)` An optional password for fetch_url.
`DatafeedFetchSchedule`	`setPaused(Boolean paused)` Whether the scheduled fetch is paused or not.
`DatafeedFetchSchedule`	`setTimeZone(String timeZone)` Time zone used for schedule.
`DatafeedFetchSchedule`	`setUsername(String username)` An optional user name for fetch_url.
`DatafeedFetchSchedule`	`setWeekday(String weekday)` The day of the week the feed file should be fetched.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - DatafeedFetchSchedule
```
public DatafeedFetchSchedule()
```
- Method Detail
  - getDayOfMonth
```
public Long getDayOfMonth()
```
    The day of the month the feed file should be fetched (1-31).
    
    Returns:
    
    value or null for none
  - setDayOfMonth
```
public DatafeedFetchSchedule setDayOfMonth(Long dayOfMonth)
```
    The day of the month the feed file should be fetched (1-31).
    
    Parameters:
    
    dayOfMonth - dayOfMonth or null for none
  - getFetchUrl
```
public String getFetchUrl()
```
    The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
    
    Returns:
    
    value or null for none
  - setFetchUrl
```
public DatafeedFetchSchedule setFetchUrl(String fetchUrl)
```
    The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
    
    Parameters:
    
    fetchUrl - fetchUrl or null for none
  - getHour
```
public Long getHour()
```
    The hour of the day the feed file should be fetched (0-23).
    
    Returns:
    
    value or null for none
  - setHour
```
public DatafeedFetchSchedule setHour(Long hour)
```
    The hour of the day the feed file should be fetched (0-23).
    
    Parameters:
    
    hour - hour or null for none
  - getMinuteOfHour
```
public Long getMinuteOfHour()
```
    The minute of the hour the feed file should be fetched (0-59). Read-only.
    
    Returns:
    
    value or null for none
  - setMinuteOfHour
```
public DatafeedFetchSchedule setMinuteOfHour(Long minuteOfHour)
```
    The minute of the hour the feed file should be fetched (0-59). Read-only.
    
    Parameters:
    
    minuteOfHour - minuteOfHour or null for none
  - getPassword
```
public String getPassword()
```
    An optional password for fetch_url.
    
    Returns:
    
    value or null for none
  - setPassword
```
public DatafeedFetchSchedule setPassword(String password)
```
    An optional password for fetch_url.
    
    Parameters:
    
    password - password or null for none
  - getPaused
```
public Boolean getPaused()
```
    Whether the scheduled fetch is paused or not.
    
    Returns:
    
    value or null for none
  - setPaused
```
public DatafeedFetchSchedule setPaused(Boolean paused)
```
    Whether the scheduled fetch is paused or not.
    
    Parameters:
    
    paused - paused or null for none
  - getTimeZone
```
public String getTimeZone()
```
    Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
    
    Returns:
    
    value or null for none
  - setTimeZone
```
public DatafeedFetchSchedule setTimeZone(String timeZone)
```
    Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
    
    Parameters:
    
    timeZone - timeZone or null for none
  - getUsername
```
public String getUsername()
```
    An optional user name for fetch_url.
    
    Returns:
    
    value or null for none
  - setUsername
```
public DatafeedFetchSchedule setUsername(String username)
```
    An optional user name for fetch_url.
    
    Parameters:
    
    username - username or null for none
  - getWeekday
```
public String getWeekday()
```
    The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
    
    Returns:
    
    value or null for none
  - setWeekday
```
public DatafeedFetchSchedule setWeekday(String weekday)
```
    The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
    
    Parameters:
    
    weekday - weekday or null for none
  - set
```
public DatafeedFetchSchedule set(String fieldName,
                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DatafeedFetchSchedule clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class DatafeedFetchSchedule

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

DatafeedFetchSchedule

Method Detail

getDayOfMonth

setDayOfMonth

getFetchUrl

setFetchUrl

getHour

setHour

getMinuteOfHour

setMinuteOfHour

getPassword

setPassword

getPaused

setPaused

getTimeZone

setTimeZone

getUsername

setUsername

getWeekday

setWeekday

set

clone