Skip to main content
The Model Outages API allows you to create, list, and delete model outages. A model outage represents an outage of a model line.

​
Resource

​
ModelOutage

​
name
string
required
Resource name with pattern modelProviders/{model_provider}/modelSuites/{model_suite}/modelLines/{model_line}/modelOutages/{model_outage}
​
outage_interval
Interval
required
Time interval in which the parent ModelLine cannot be used to generate sketches.If a report spans across one or more ModelOutages, the whole report must be generated using the parent ModelLine’s holdback_model_line.This field is immutable after creation.
​
state
State
State of this ModelOutage.Enum values:
  • STATE_UNSPECIFIED: Default value, should never be used
  • ACTIVE: The ModelOutage has been created
  • DELETED: The ModelOutage has been deleted (terminal state). ModelOutages with state equal to DELETED must not be considered to determine what ModelLine must be used to generate reports
​
create_time
Timestamp
When the ModelOutage was created
​
delete_time
Timestamp
When the ModelOutage was deleted

​
Methods

​
CreateModelOutage

Creates a new ModelOutage. A ModelOutage can be created only for a ModelLine with type equal to PROD. Furthermore, the ModelLine.holdback_model_line needs to be already specified.
​
parent
string
required
Resource name of the parent ModelLine.Format: modelProviders/{model_provider}/modelSuites/{model_suite}/modelLines/{model_line}
​
model_outage
ModelOutage
required
The ModelOutage to create. The name field will be ignored, and the system will assign an ID.Required fields:
  • outage_interval: Time interval for the outage
Response Returns the created ModelOutage resource. Example Request 
CreateModelOutageRequest {
  parent: "modelProviders/123/modelSuites/456/modelLines/789"
  model_outage: {
    outage_interval: {
      start_time: { seconds: 1609459200 }
      end_time: { seconds: 1609545600 }
    }
  }
}

​
ListModelOutages

Lists ModelOutage resources for a ModelLine.
​
parent
string
required
Resource name of the parent ModelLine.Format: modelProviders/{model_provider}/modelSuites/{model_suite}/modelLines/{model_line}
​
page_size
int32
The maximum number of ModelOutages to return. The service may return fewer than this value.
  • If unspecified, at most 50 ModelOutages will be returned
  • Maximum value is 1000; values above 1000 will be coerced to 1000
​
page_token
string
A page token received from a previous ListModelOutages call. Provide this to retrieve the subsequent page.When paginating, all other parameters must match the call that provided the page token.
​
show_deleted
bool
Whether to include ModelOutages in the DELETED state or not.
​
filter
Filter
Structured filter criteria.
​
filter.outage_interval_overlapping
Interval
Matches against the outage_interval of the ModelOutage.
Response
​
model_outages
ModelOutage[]
List of ModelOutage resources
​
next_page_token
string
A token that can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.
Example Request 
ListModelOutagesRequest {
  parent: "modelProviders/123/modelSuites/456/modelLines/789"
  show_deleted: false
  filter: {
    outage_interval_overlapping: {
      start_time: { seconds: 1609459200 }
      end_time: { seconds: 1640995200 }
    }
  }
  page_size: 50
}

​
DeleteModelOutage

Deletes an existing ModelOutage. ModelOutage will transition to a DELETED state. This action is irreversible. Results in a NOT_FOUND error if the specified ModelOutage does not exist or it has been already deleted. This is a soft delete as defined by https://google.aip.dev/216.
​
name
string
required
The name of the ModelOutage to delete.Format: modelProviders/{model_provider}/modelSuites/{model_suite}/modelLines/{model_line}/modelOutages/{model_outage}
Response Returns the updated ModelOutage resource in DELETED state. Example Request 
DeleteModelOutageRequest {
  name: "modelProviders/123/modelSuites/456/modelLines/789/modelOutages/101"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us