Recurso de REST: sites.versions

Recurso: Version

Un recurso Version es la colección de configuración y 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

Es el identificador único de una versión, que tiene el siguiente formato:

sites/site-name/versions/versionID

Este nombre se proporciona en el cuerpo de la respuesta cuando llamas al extremo versions.create.

status

enum (VersionStatus)

Es el estado de implementación de una versión.

Para lograr una implementación correcta, llama al extremo versions.create a fin de crear una versión nueva (estado CREATED), sube todos los archivos deseados a ella y, luego, actualízala al estado FINALIZED.

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

También puedes cambiar el estado de una versión a DELETED si llamas al extremo versions.delete.

config

object (ServingConfig)

Es la configuración del comportamiento del sitio. Esta configuración existe en el archivo firebase.json.

labels

map (key: string, value: string)

Las etiquetas que se usan para metadatos adicionales o filtros.

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

createTime

string (Timestamp format)

Solo salida. La hora en la que se creó la versión.

Una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

createUser

object (ActingUser)

Solo salida. Identifica al usuario que creó la versión.

finalizeTime

string (Timestamp format)

Solo salida. La hora en la que el estado de la versión cambió a FINALIZED.

Una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

finalizeUser

object (ActingUser)

Solo salida. Identifica al usuario que cambió el estado de la versión a FINALIZED.

deleteTime

string (Timestamp format)

Solo salida. La hora en la que el estado de la versión cambió a DELETED.

Una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

deleteUser

object (ActingUser)

Solo salida. Identifica al usuario que cambió el estado de la versión a DELETED.

fileCount

string (int64 format)

Solo salida. La cantidad total de archivos asociados con la versión.
Este valor se calcula después de que el estado de una versión se cambió a FINALIZED.

versionBytes

string (int64 format)

Solo salida. El tamaño total de bytes almacenados de la versión.
Este valor se calcula después de que el estado de una versión se cambió a FINALIZED.

VersionStatus

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

Enums
VERSION_STATUS_UNSPECIFIED El estado predeterminado; no debe usarse de forma intencional.
CREATED Se creó la versión y actualmente se está agregando contenido a esta.
FINALIZED Todo el contenido se agregó a la versión y esta ya no se puede cambiar.
DELETED Se borró la versión.
ABANDONED La versión no se actualizó a FINALIZED en un período de 12 horas y se borró automáticamente.
EXPIRED La versión está fuera del límite configurado por el sitio para el número de versiones retenidas, por lo que el contenido de la versión está programado para su eliminación.

ServingConfig

La configuración de la forma en que se deben enrutar y procesar las solicitudes entrantes a un sitio antes de entregar el contenido. Los patrones se combinan y aplican 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)
}
Campos
headers[]

object (Header)

Una lista de encabezados de respuesta personalizados que se agregan al contenido si la ruta de la URL de solicitud coincide con el patrón glob.

redirects[]

object (Redirect)

Una lista de globs que harán que la respuesta redireccione a otra ubicación.

rewrites[]

object (Rewrite)

Una lista de reescrituras que actuarán como si al servicio se le otorgara la URL de destino.

cleanUrls

boolean

Define si se quita la extensión de archivo de los archivos subidos.

trailingSlashBehavior

enum (TrailingSlashBehavior)

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

Header

Un recurso header define los encabezados personalizados que se deben agregar a una respuesta si la ruta de la URL de solicitud coincide con el patrón.

Representación JSON

{
  "glob": string,
  "headers": {
    string: string,
    ...
  }
}
Campos
glob

string

Obligatorio. El patrón glob suministrado por el usuario que debe coincidir con la ruta de la URL de solicitud.

headers

map (key: string, value: string)

Obligatorio. Los encabezados adicionales que se deben agregar a la respuesta.

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

Redireccionamiento

Un recurso redirect representa la configuración para mostrar una respuesta de redireccionamiento HTTP según una ruta de URL de solicitud coincidente.

Representación JSON

{
  "glob": string,
  "statusCode": number,
  "location": string
}
Campos
glob

string

Obligatorio. El patrón glob suministrado por el usuario que debe coincidir con la ruta de la URL de solicitud.

statusCode

number

Obligatorio. El código HTTP del estado que se debe mostrar en la respuesta. Debe ser un código de estado 3xx válido.

location

string

Obligatorio. El valor que debe colocarse en el encabezado de ubicación HTTP de la respuesta.
Nama ini disediakan di badan respons saat Anda memanggil La ubicación puede contener valores de grupo de captura del patrón mediante el uso del prefijo : para identificar el segmento y un signo * opcional para capturar el resto de la URL. Por ejemplo:

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

Rewrite

Un recurso rewrite representa una reescritura interna de contenido sobre la versión. Si el patrón coincide, la solicitud se manejará como si se tratara de la ruta de destino especificada en la configuración.

Representación JSON

{
  "glob": string,

  // 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
glob

string

Obligatorio. El patrón glob suministrado por el usuario que debe coincidir con la ruta de la URL de solicitud.

Campo de unión behavior. Obligatorio. El comportamiento de la reescritura. El valor behavior solo puede ser uno de los siguientes:
path

string

La ruta de la URL a la cual reescribir la solicitud.

function

string

La función para almacenar en servidores proxy las solicitudes. Debe coincidir con el nombre de la función exportada de manera exacta.

run

object (CloudRunRewrite)

La solicitud se reenviará a Cloud Run.

CloudRunRewrite

Una reescritura configurada que dirige las solicitudes a un servicio de Cloud Run. Si el servicio de Cloud Run no existe cuando se establece o actualiza la configuración de Firebase Hosting, fallará la solicitud. Los errores del servicio de Cloud Run se pasan al usuario final (por ejemplo, si borras un servicio, cualquier solicitud dirigida a ese servicio recibe un error 404).

Representación JSON

{
  "serviceId": string,
  "region": string
}
Campos
serviceId

string

Obligatorio ID definido por el usuario del servicio de Cloud Run.

region

string

Opcional: Región proporcionada por el usuario donde se aloja el servicio de Cloud Run.
La configuración predeterminada es us-central1 si no se suministra.

TrailingSlashBehavior

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

Enums
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED No se especifica ningún comportamiento.
Los archivos se entregan en su ubicación exacta únicamente y las barras finales solo se agregan a los índices de directorio.
ADD Las barras finales se agregan a los índices de directorio y a cualquier ruta de URL que no termine en una extensión de archivo.
REMOVE Las barras finales se quitan de los índices de directorio y también de cualquier ruta de URL que no termine en una extensión de archivo.

Métodos

create

Crea una versión nueva de un sitio.

delete

Borra la versión especificada.

patch

Actualiza los metadatos especificados para una versión.

populateFiles

Agrega archivos de contenido a una versión.