REST Resource: projects.locations.exclusionWindows

Resource: ExclusionWindow

A period during which experiments are not supposed to run.

JSON representation
{
  "name": string,
  "description": string,
  "duration": string,
  "startTime": string,
  "endTime": string
}
Fields
name

string

Identifier. The resource name of the exclusion window. Format: projects/{project}/locations/{location}/exclusionWindows/{exclusionWindow}

description

string

Optional. Optional user-provided description. Min length 0. Max length 2000.

duration

string (Duration format)

Required. How long the exclusion window lasts once started.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

startTime

string (Timestamp format)

Output only. When the exclusion window started, or empty if it has not been started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Output only. When the exclusion window ends, or empty if it has not been started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Methods

create

Creates a new exclusion window.

delete

Deletes an exclusion window.

get

Get the details of an exclusion window.

list

Lists all exclusion windows in a project and region, or all exclusion windows in a project in all regions if the location is given as "-".

patch

Updates an exclusion window.

start

Starts or restarts an existing exclusion window.

stop

Stops an active exclusion window.