GoogleVideoSitemapUrl.Options (SitemapGen4J 1.0.4 API)

java.lang.Object
- com.redfin.sitemapgenerator.GoogleVideoSitemapUrl.Options

Enclosing class:

GoogleVideoSitemapUrl
```
public static class GoogleVideoSitemapUrl.Options
extends Object
```
Options to configure Google Video URLs

Constructor Summary

Constructors
Constructor and Description
`Options(URL url, URL contentUrl)` Specifies a landing page URL, together with the URL of the underlying video (e.g.
`Options(URL url, URL playerUrl, boolean allowEmbed)` Specifies a landing page URL, together with a "player" (e.g.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`U`	`build()` Return an URL based on these settings
`GoogleVideoSitemapUrl.Options`	`category(String category)` The video's category; for example, `cooking`.
`THIS`	`changeFreq(ChangeFreq changeFreq)` How frequently the page is likely to change.
`GoogleVideoSitemapUrl.Options`	`contentUrl(URL contentUrl)` Specifies the URL of the underlying video (e.g FLV)
`GoogleVideoSitemapUrl.Options`	`description(String description)` The description of the video.
`GoogleVideoSitemapUrl.Options`	`durationInSeconds(int durationInSeconds)` The duration of the video in seconds; value must be between 0 and 28800 (8 hours).
`GoogleVideoSitemapUrl.Options`	`familyFriendly(boolean familyFriendly)` Whether the video is suitable for viewing by children
`THIS`	`lastMod(Date lastMod)` The date of last modification of the file.
`THIS`	`lastMod(String lastMod)` The date of last modification of the file.
`GoogleVideoSitemapUrl.Options`	`playerUrl(URL playerUrl, boolean allowEmbed)` Specifies a player URL (e.g.
`THIS`	`priority(Double priority)` The priority of this URL relative to other URLs on your site.
`GoogleVideoSitemapUrl.Options`	`publicationDate(Date publicationDate)` The date the video was first published, in `W3CDateFormat`.
`GoogleVideoSitemapUrl.Options`	`rating(Double rating)` The rating of the video.
`GoogleVideoSitemapUrl.Options`	`tags(ArrayList<String> tags)` Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content.
`GoogleVideoSitemapUrl.Options`	`tags(Iterable<String> tags)` Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content.
`GoogleVideoSitemapUrl.Options`	`tags(String... tags)` Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content.
`GoogleVideoSitemapUrl.Options`	`thumbnailUrl(URL thumbnailUrl)` A URL pointing to the URL for the video thumbnail image file.
`GoogleVideoSitemapUrl.Options`	`title(String title)` The title of the video.
`GoogleVideoSitemapUrl.Options`	`viewCount(int viewCount)` The number of times the video has been viewed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Options
```
public Options(URL url,
               URL playerUrl,
               boolean allowEmbed)
```
    Specifies a landing page URL, together with a "player" (e.g. SWF)
    
    Parameters:
    
    url - the landing page URL
    
    playerUrl - the URL of the "player" (e.g. SWF file)
    
    allowEmbed - when specifying a player, you must specify whether embedding is allowed
  - Options
```
public Options(URL url,
               URL contentUrl)
```
    Specifies a landing page URL, together with the URL of the underlying video (e.g. FLV)
    
    Parameters:
    
    url - the landing page URL
    
    contentUrl - the URL of the underlying video (e.g. FLV)
- Method Detail
  - playerUrl
```
public GoogleVideoSitemapUrl.Options playerUrl(URL playerUrl,
                                               boolean allowEmbed)
```
    Specifies a player URL (e.g. SWF)
    
    Parameters:
    
    playerUrl - the URL of the "player" (e.g. SWF file)
    
    allowEmbed - when specifying a player, you must specify whether embedding is allowed
  - contentUrl
```
public GoogleVideoSitemapUrl.Options contentUrl(URL contentUrl)
```
    Specifies the URL of the underlying video (e.g FLV)
  - thumbnailUrl
```
public GoogleVideoSitemapUrl.Options thumbnailUrl(URL thumbnailUrl)
```
    A URL pointing to the URL for the video thumbnail image file. This allows you to suggest the thumbnail you want displayed in search results. If you provide a contentUrl(URL), Google will attempt to generate a set of representative thumbnail images from your actual video content. However, we strongly recommended that you provide a thumbnail URL to increase the likelihood of your video being included in the video index.
  - title
```
public GoogleVideoSitemapUrl.Options title(String title)
```
    The title of the video. Limited to 100 characters.
  - description
```
public GoogleVideoSitemapUrl.Options description(String description)
```
    The description of the video. Descriptions longer than 2048 characters will be truncated.
  - rating
```
public GoogleVideoSitemapUrl.Options rating(Double rating)
```
    The rating of the video. The value must be number in the range 0.0-5.0.
  - viewCount
```
public GoogleVideoSitemapUrl.Options viewCount(int viewCount)
```
    The number of times the video has been viewed
  - publicationDate
```
public GoogleVideoSitemapUrl.Options publicationDate(Date publicationDate)
```
    The date the video was first published, in W3CDateFormat.
  - tags
```
public GoogleVideoSitemapUrl.Options tags(ArrayList<String> tags)
```
    Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content. A single video could have several tags, although it might belong to only one category. For example, a video about grilling food may belong in the Grilling category, but could be tagged "steak", "meat", "summer", and "outdoor". Create a new element for each tag associated with a video. A maximum of 32 tags is permitted.
  - tags
```
public GoogleVideoSitemapUrl.Options tags(Iterable<String> tags)
```
    Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content. A single video could have several tags, although it might belong to only one category. For example, a video about grilling food may belong in the Grilling category, but could be tagged "steak", "meat", "summer", and "outdoor". Create a new element for each tag associated with a video. A maximum of 32 tags is permitted.
  - tags
```
public GoogleVideoSitemapUrl.Options tags(String... tags)
```
    Tag associated with the video; tags are generally very short descriptions of key concepts associated with a video or piece of content. A single video could have several tags, although it might belong to only one category. For example, a video about grilling food may belong in the Grilling category, but could be tagged "steak", "meat", "summer", and "outdoor". Create a new element for each tag associated with a video. A maximum of 32 tags is permitted.
  - category
```
public GoogleVideoSitemapUrl.Options category(String category)
```
    The video's category; for example, cooking. The value should be a string no longer than 256 characters. In general, categories are broad groupings of content by subject. Usually a video will belong to a single category. For example, a site about cooking could have categories for Broiling, Baking, and Grilling
  - familyFriendly
```
public GoogleVideoSitemapUrl.Options familyFriendly(boolean familyFriendly)
```
    Whether the video is suitable for viewing by children
  - durationInSeconds
```
public GoogleVideoSitemapUrl.Options durationInSeconds(int durationInSeconds)
```
    The duration of the video in seconds; value must be between 0 and 28800 (8 hours).
  - lastMod
```
public THIS lastMod(Date lastMod)
```
    The date of last modification of the file. Note that this tag is separate from the If-Modified-Since (304) header the server can return, and search engines may use the information from both sources differently.
  - lastMod
```
public THIS lastMod(String lastMod)
             throws ParseException
```
    The date of last modification of the file. Note that this tag is separate from the If-Modified-Since (304) header the server can return, and search engines may use the information from both sources differently.
    
    Throws:
    
    ParseException - if the string isn't a valid W3C date time
    
    See Also:
    
    W3CDateFormat
  - changeFreq
```
public THIS changeFreq(ChangeFreq changeFreq)
```
    How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page. The value ChangeFreq.ALWAYS should be used to describe documents that change each time they are accessed. The value ChangeFreq.NEVER should be used to describe archived URLs.
    Please note that the value of this tag is considered a hint and not a command. Even though search engine crawlers may consider this information when making decisions, they may crawl pages marked ChangeFreq.HOURLY less frequently than that, and they may crawl pages marked ChangeFreq.YEARLY more frequently than that. Crawlers may periodically crawl pages marked ChangeFreq.NEVER so that they can handle unexpected changes to those pages.
  - priority
```
public THIS priority(Double priority)
```
    The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0. This value does not affect how your pages are compared to pages on other sites-it only lets the search engines know which pages you deem most important for the crawlers.
    
    The default priority of a page is 0.5.
    
    Please note that the priority you assign to a page is not likely to influence the position of your URLs in a search engine's result pages. Search engines may use this information when selecting between URLs on the same site, so you can use this tag to increase the likelihood that your most important pages are present in a search index.
    
    Also, please note that assigning a high priority to all of the URLs on your site is not likely to help you. Since the priority is relative, it is only used to select between URLs on your site.
  - build
```
public U build()
```
    Return an URL based on these settings

Class GoogleVideoSitemapUrl.Options

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Options

Options

Method Detail

playerUrl

contentUrl

thumbnailUrl

title

description

rating

viewCount

publicationDate

tags

tags

tags

category

familyFriendly

durationInSeconds

lastMod

lastMod

changeFreq

priority

build