REST Resource: sites.versions

Recurso: Versión

Una Version es una configuración y una colección de archivos estáticos que determinan cómo se muestra un sitio.

Representación JSON
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
Campos
name

string

El nombre de recurso completo para la versión, en el formato:

sites/ SITE_ID /versions/ VERSION_ID

Este nombre se proporciona en el cuerpo de la respuesta cuando llama a versions.create .

status

enum ( VersionStatus )

El estado de implementación de la versión.

Para una implementación exitosa, llame a versions.create para crear una nueva versión (estado CREATED ), cargue todos los archivos deseados en la versión y luego actualice la versión al estado FINALIZED .

Tenga en cuenta que si deja la versión en el estado CREATED durante más de 12 horas, el sistema marcará automáticamente la versión como ABANDONED .

También puede cambiar el estado de una versión a DELETED llamando a versions.delete .

config

object ( ServingConfig )

La configuración para el comportamiento del sitio. Esta configuración existe en el archivo firebase.json .

labels

map (key: string, value: string)

Las etiquetas utilizadas para metadatos y/o filtrado adicionales.

Un objeto que contiene una lista de pares "key": value . Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Sólo salida. La hora a la que se creó la versión.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Sólo salida. Identifica el usuario que creó la versión.

finalizeTime

string ( Timestamp format)

Sólo salida. La hora en la que se FINALIZED la versión.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Sólo salida. Identifica el usuario que FINALIZED la versión.

deleteTime

string ( Timestamp format)

Sólo salida. La hora a la que se DELETED la versión.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Sólo salida. Identifica el usuario que DELETED la versión.

fileCount

string ( int64 format)

Sólo salida. El número total de archivos asociados con la versión.

Este valor se calcula después de FINALIZED una versión.

versionBytes

string ( int64 format)

Sólo salida. El tamaño total de bytes almacenados de la versión.

Este valor se calcula después de FINALIZED una versión.

Estado de la versión

El estado actual conocido de una versión específica en el ciclo de vida de implementación.

Enumeraciones
VERSION_STATUS_UNSPECIFIED El estado predeterminado; no debe usarse intencionalmente.
CREATED La versión ha sido creada y actualmente se está agregando contenido a la versión.
FINALIZED Todo el contenido se ha agregado a la versión y la versión ya no se puede cambiar.
DELETED La versión ha sido eliminada.
ABANDONED La versión no se actualizó a FINALIZED dentro de las 12 horas y se eliminó automáticamente.
EXPIRED La versión está fuera del límite configurado por el sitio para la cantidad de versiones retenidas, por lo que el contenido de la versión está programado para su eliminación.
CLONING La versión está siendo clonada a partir de otra versión. Todo el contenido todavía se está copiando.

Configuración de servicio

La configuración de cómo se deben enrutar y procesar las solicitudes entrantes a un sitio antes de entregar contenido. Las rutas de solicitud de URL se comparan con los patrones de URL especificados en la configuración, luego Hosting aplica la configuración aplicable de acuerdo con un orden de prioridad específico.

Representación JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Campos
headers[]

object ( Header )

Una matriz de objetos, donde cada objeto especifica un patrón de URL que, si coincide con la ruta de URL de la solicitud, hace que Hosting aplique los encabezados de respuesta personalizados especificados.

redirects[]

object ( Redirect )

Una matriz de objetos (llamadas reglas de redireccionamiento), donde cada regla especifica un patrón de URL que, si coincide con la ruta URL de la solicitud, hace que Hosting responda con una redirección a la ruta de destino especificada.

rewrites[]

object ( Rewrite )

Una matriz de objetos (llamadas reglas de reescritura), donde cada regla especifica un patrón de URL que, si coincide con la ruta de la URL de solicitud, hace que Hosting responda como si el servicio recibiera la URL de destino especificada.

cleanUrls

boolean

Define si se eliminará la extensión del archivo de los archivos cargados.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Define cómo manejar una barra diagonal final en la ruta URL.

i18n

object ( I18nConfig )

Opcional. Define el comportamiento de reescritura de i18n.

Un Header especifica un patrón de URL que, si coincide con la ruta URL de la solicitud, hace que Hosting aplique los encabezados de respuesta personalizados especificados.

Representación JSON
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Campos
headers

map (key: string, value: string)

Requerido. Los encabezados adicionales para agregar a la respuesta.

Un objeto que contiene una lista de pares "key": value . Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern de campo de unión.
Requerido. Un patrón de URL de cadena que se debe comparar con la ruta de la URL de solicitud para determinar si se aplica este encabezado de respuesta personalizado. Puede ser un globo estilo Bash o una expresión regular RE2.

pattern puede ser sólo uno de los siguientes:
glob

string

El globo proporcionado por el usuario para compararlo con la ruta URL de la solicitud.

regex

string

La expresión regular RE2 proporcionada por el usuario para compararla con la ruta URL de solicitud.

Redirigir

Un Redirect especifica un patrón de URL que, si coincide con la ruta URL de la solicitud, hace que Hosting responda con una redirección a la ruta de destino especificada.

Representación JSON
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Campos
statusCode

integer

Requerido. El código HTTP de estado que se devolverá en la respuesta. Debe ser un código de estado 3xx válido.

location

string

Requerido. El valor que se colocará en el encabezado de ubicación HTTP de la respuesta.

La ubicación puede contener valores de grupo de captura del patrón usando un prefijo : para identificar el segmento y un * opcional para capturar el resto de la URL. Por ejemplo:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"

pattern de campo de unión.
Requerido. Un patrón de URL de cadena que se debe comparar con la ruta de la URL de solicitud para determinar si se aplica esta redirección. Puede ser un globo estilo Bash o una expresión regular RE2.

pattern puede ser sólo uno de los siguientes:
glob

string

El globo proporcionado por el usuario para compararlo con la ruta URL de la solicitud.

regex

string

La expresión regular RE2 proporcionada por el usuario para compararla con la ruta URL de solicitud.

Volver a escribir

Una Rewrite especifica un patrón de URL que, si coincide con la ruta de la URL de solicitud, hace que Hosting responda como si el servicio recibiera la URL de destino especificada.

Representación JSON
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
Campos
functionRegion

string

Opcional. Especifique una región de la nube para las invocaciones de funciones reescritas. Si no se proporciona, el valor predeterminado es us-central1.

pattern de campo de unión.
Requerido. Un patrón de URL de cadena que se debe comparar con la ruta de la URL de solicitud para determinar si se debe aplicar esta reescritura. Puede ser un globo estilo Bash o una expresión regular RE2.

pattern puede ser sólo uno de los siguientes:
glob

string

El globo proporcionado por el usuario para compararlo con la ruta URL de la solicitud.

regex

string

La expresión regular RE2 proporcionada por el usuario para compararla con la ruta URL de solicitud.

behavior en el campo sindical.
Requerido. El comportamiento de la reescritura.

behavior puede ser sólo uno de los siguientes:
path

string

La ruta URL para reescribir la solicitud.

function

string

La función para enviar solicitudes a. Debe coincidir exactamente con el nombre de la función exportada.

run

object ( CloudRunRewrite )

La solicitud se enviará a Cloud Run.

NubeRunReescribir

Una reescritura configurada que dirige las solicitudes a un servicio Cloud Run. Si el servicio Cloud Run no existe al configurar o actualizar su configuración de Firebase Hosting, entonces la solicitud falla. Cualquier error del servicio Cloud Run se pasa al usuario final (por ejemplo, si elimina un servicio, cualquier solicitud dirigida a ese servicio recibe un error 404 ).

Representación JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Campos
serviceId

string

Requerido. ID definido por el usuario del servicio Cloud Run.

region

string

Opcional. Región proporcionada por el usuario donde se aloja el servicio Cloud Run.

El valor predeterminado es us-central1 si no se proporciona.

tag

string

Opcional. Etiqueta TrafficConfig proporcionada por el usuario a la que enviar tráfico.

Cuando se omite, el tráfico se envía al URI de todo el servicio.

Comportamiento de barra diagonal final

Define si se debe agregar o eliminar una barra diagonal final de la ruta URL de solicitud.

Enumeraciones
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

No se especifica ningún comportamiento.

Los archivos se entregan únicamente en su ubicación exacta y las barras diagonales finales solo se agregan a los índices de directorio.

ADD Se agregan barras diagonales a los índices de directorios, así como a cualquier ruta URL que no termine en una extensión de archivo.
REMOVE Las barras diagonales se eliminan de los índices de directorios, así como de cualquier ruta URL que no termine en una extensión de archivo.

Configuración I18n

Si se proporcionan, las reescrituras de i18n están habilitadas.

Representación JSON
{
  "root": string
}
Campos
root

string

Requerido. La ruta proporcionada por el usuario donde se buscará contenido específico de país e idioma dentro del directorio público.

Métodos

clone

Crea una nueva versión en el sitio de destino especificado utilizando el contenido de la versión especificada.

create

Crea una nueva versión para el sitio especificado.

delete

Elimina la versión especificada.

get

Obtenga la versión especificada que se ha creado para el sitio especificado.

list

Enumera las versiones que se han creado para el sitio especificado.

patch

Actualiza los metadatos especificados para la versión especificada.

populateFiles

Agrega archivos de contenido a la versión especificada.