REST Resource: projects.locations.producerExtensions

Resource: ProducerExtension

ProducerExtension is a resource representing producer defined configuration for their service extension.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "etag": string,
  "phase": enum (Phase),
  "extensionSettings": {
    object (ExtensionSettings)
  }
}
Fields
name

string

Identifier. Name of the ProducerExtension resource in the following format: projects/{project}/locations/{location}/producerExtensions/{producerExtension}.

createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

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".

updateTime

string (Timestamp format)

Output only. The timestamp when the resource was updated.

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".

description

string

Optional. A human-readable description of the resource.

labels

map (key: string, value: string)

Optional. Set of labels associated with the ProducerExtension resource.

The format must comply with the following requirements.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.

phase

enum (Phase)

Required. The phase in which this ProducerExtension should execute.

extensionSettings

object (ExtensionSettings)

Required. The configuration for the service that this ProducerExtension offers.

Phase

The phase of a ProducerExtension determines when it will be executed.

Enums
PHASE_UNSPECIFIED Unspecified phase.
TRAFFIC The ProducerExtension will be executed during the traffic phase.
AUTHZ The ProducerExtension will be executed during the authorization phase.

ExtensionSettings

The configuration for the service that this ProducerExtension offers.

JSON representation
{
  "service": string,
  "authority": string,
  "supportedEvents": [
    enum (EventType)
  ]
}
Fields
service

string

Required. URI of the PSC attachment.

authority

string

Optional. The :authority header in the request sent to the extension service.

supportedEvents[]

enum (EventType)

Required. The event types supported by the extension.

Methods

create

Creates a new ProducerExtension resource in a given project and location.

delete

Deletes the specified ProducerExtension resource.

get

Gets details of the specified ProducerExtension resource.

list

Lists ProducerExtension resources in a given project and location.