- Resource: EdgeCacheOrigin
- Protocol
- RetryConditions
- Timeout
- AWSV4Signature
- OriginOverrideAction
- OriginUrlRewrite
- OriginHeaderAction
- AddHeader
- OriginRedirect
- RedirectConditions
- Methods
Resource: EdgeCacheOrigin
Represents an HTTP-reachable backend for an EdgeCacheService
resource.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "description": string, "labels": { string: string, ... }, "originAddress": string, "protocol": enum ( |
Fields | |
---|---|
name |
Required. The name of the resource as provided by the client when the resource is created. The name must be 1-64 characters long, and match the regular expression |
createTime |
Output only. The creation timestamp in RFC3339 text format. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The update timestamp in RFC3339 text format. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
description |
Optional. A human-readable description of the resource. |
labels |
Optional. A set of label tags associated with the An object containing a list of |
originAddress |
Required. A fully qualified domain name (FQDN), an IPv4 or IPv6 address reachable over the public internet, or the address of a Google Cloud Storage bucket. This address is used as the origin for cache requests. The following are example origins:
The following limitations apply to fully-qualified domain names:
When providing an IP address, it must be publicly routable. IPv6 addresses must not be enclosed in square brackets. |
protocol |
Optional. The protocol to use to connect to the configured origin. Defaults to HTTP2, which is strongly recommended for both security and performance. When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed, unexpired TLS (SSL) certificate must be presented by the origin server. |
port |
Optional. The port to connect to the origin on. Defaults to port 443 for HTTP2 and HTTPS protocols and port 80 for HTTP. |
maxAttempts |
Optional. The maximum number of attempts to cache fill from this origin. Another attempt is made when a cache fill fails with one of the Once the maximum attempts to this origin have failed, the failover origin][], if specified, is used. The failover origin can have its own The total number of allowed attempts to cache fill across this and failover origins is limited to four. The total time allowed for cache fill attempts across this and failover origins can be controlled with The last valid, non-retried response from all origins is returned to the client. If no origin returns a valid response, an Defaults to 1. Must be a value greater than 0 and less than 5. |
failoverOrigin |
Optional. The The following are both valid paths to an
The value of [maxAttemptsTimeout][] dictates the timeout across all origins. |
retryConditions[] |
Optional. Specifies one or more retry conditions for the configured origin. If the failure mode during a connection attempt to the origin matches the configured The default
For a list of valid values, see |
timeout |
Optional. The connection and HTTP timeout configuration for this origin. |
awsV4Authentication |
Optional. Enable AWS Signature Version 4 origin authentication. |
originOverrideAction |
Optional. The override actions, including URL rewrites and header additions, for requests that use this origin. |
originRedirect |
Optional. Follow redirects from this origin. |
Protocol
The HTTP protocol to use for connecting to the origin.
Enums | |
---|---|
PROTOCOL_UNSPECIFIED |
Unspecified value. Defaults to HTTP2. |
HTTP2 |
The HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS). Requires a valid (public and unexpired) TLS certificate present on the origin. |
HTTPS |
HTTP/1.1 with TLS (SSL). Requires a valid (public and unexpired) TLS certificate present on the origin. |
HTTP |
HTTP without TLS (SSL). This is not recommended, because communication outside of Google's network is unencrypted to the public endpoint (origin). |
RetryConditions
One or more retry conditions for the configured origin.
Enums | |
---|---|
RETRY_CONDITIONS_UNSPECIFIED |
Unspecified |
CONNECT_FAILURE |
Retry on failures connecting to origins include routing, DNS and TLS handshake errors, and TCP/UDP timeouts. |
HTTP_5XX |
Retry if the origin responds with any HTTP 5xx response code. |
GATEWAY_ERROR |
Similar to 5xx , but only applies to HTTP response codes 502 , 503 , or 504 . |
RETRIABLE_4XX |
Retry for retriable 4xx response codes, which include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests) . |
NOT_FOUND |
Retry if the origin returns an HTTP 404 (Not Found) error. This can be useful when generating video content when the segment is not yet available. |
FORBIDDEN |
Retry if the origin returns an HTTP 403 (Forbidden) error. This can be useful for origins that return 403 (instead of 404 ) for missing content for security reasons. |
Timeout
The timeout configuration for this origin.
JSON representation |
---|
{ "connectTimeout": string, "maxAttemptsTimeout": string, "responseTimeout": string, "readTimeout": string } |
Fields | |
---|---|
connectTimeout |
Optional. The maximum duration to wait for a single origin connection to be established, including DNS lookup, TLS handshake, and TCP/QUIC connection establishment. Defaults to 5 seconds. The timeout must be a value between 1s and 15s. The A duration in seconds with up to nine fractional digits, ending with ' |
maxAttemptsTimeout |
Optional. The maximum time across all connection attempts to all origins, including failover origins, before returning an error to the client. An Defaults to 15 seconds. The timeout must be a value between 1s and 30s. If a [failover origin][] is specified, the A duration in seconds with up to nine fractional digits, ending with ' |
responseTimeout |
Optional. The maximum duration to wait for the last byte of a response to arrive when reading from the HTTP connection/stream. Defaults to 30 seconds. The timeout must be a value between 1s and 120s. The Origins that take longer to write additional bytes to the response than the configured If the response headers have already been written to the connection, the response is truncated and logged. A duration in seconds with up to nine fractional digits, ending with ' |
readTimeout |
Optional. The maximum duration to wait between reads of a single HTTP connection or stream. Defaults to 15 seconds. The timeout must be a value between 1s and 30s. The If the response headers have already been written to the connection, the response is truncated and logged. A duration in seconds with up to nine fractional digits, ending with ' |
AWSV4Signature
The configuration needed to generate an AWS V4 Signature
JSON representation |
---|
{ "accessKeyId": string, "secretAccessKeyVersion": string, "originRegion": string } |
Fields | |
---|---|
accessKeyId |
Required. The access key ID that your origin uses to identify the key. |
secretAccessKeyVersion |
Required. The Secret Manager secret version of the secret access key used by your origin. This is the resource name of the secret version in the format |
originRegion |
Required. The name of the AWS region that your origin is in. |
OriginOverrideAction
Defines how requests and responses can be manipulated on cache fill to this origin.
JSON representation |
---|
{ "urlRewrite": { object ( |
Fields | |
---|---|
urlRewrite |
Optional. The URL rewrite configuration for requests that are handled by this origin. |
headerAction |
Optional. The header actions, including adding and removing headers, for requests handled by this origin. |
OriginUrlRewrite
The URL rewrite configuration for a given request handled by this origin.
JSON representation |
---|
{ "hostRewrite": string } |
Fields | |
---|---|
hostRewrite |
Optional. Before forwarding the request to the selected origin, the request's The host value must be between 1 and 255 characters. |
OriginHeaderAction
Defines the addition and removal of HTTP headers for requests/responses.
JSON representation |
---|
{
"requestHeadersToAdd": [
{
object ( |
Fields | |
---|---|
requestHeadersToAdd[] |
Optional. A header to add. You can add a maximum of 25 request headers. |
AddHeader
Describes a header to add.
JSON representation |
---|
{ "headerName": string, "headerValue": string, "replace": boolean } |
Fields | |
---|---|
headerName |
Required. The name of the header to add. |
headerValue |
Required. The value of the header to add. |
replace |
Optional. Specifies whether to replace all existing headers with the same name. By default, added header values are appended to the response or request headers with the same field names. The added values are separated by commas. To overwrite existing values, set |
OriginRedirect
The options for following redirects from the origin.
JSON representation |
---|
{
"redirectConditions": [
enum ( |
Fields | |
---|---|
redirectConditions[] |
Optional. The set of HTTP redirect response codes that the CDN follows. |
RedirectConditions
The HTTP status codes that cause the CDN to follow redirects.
Enums | |
---|---|
REDIRECT_CONDITIONS_UNSPECIFIED |
It is an error to specify REDIRECT_CONDITIONS_UNSPECIFIED . |
MOVED_PERMANENTLY |
Follow redirect on an HTTP 301 error. |
FOUND |
Follow redirect on an HTTP 302 error. |
SEE_OTHER |
Follow redirect on an HTTP 303 error. |
TEMPORARY_REDIRECT |
Follow redirect on an HTTP 307 error. |
PERMANENT_REDIRECT |
Follow redirect on an HTTP 308 error. |
Methods |
|
---|---|
|
Creates a new EdgeCacheOrigin in a given project and location. |
|
Deletes a single EdgeCacheOrigin. |
|
Gets details of a single EdgeCacheOrigin. |
|
Gets the access control policy for a resource. |
|
Lists EdgeCacheOrigins in a given project and location. |
|
Updates the parameters of a single EdgeCacheOrigin. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |