Interface EndpointAuthorizationOrBuilder (0.2.0)

public interface EndpointAuthorizationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSecret()

public abstract String getSecret()

Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer <token>" or "Basic <credentials>", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during CreateSubscriber and UpdateSubscriber calls, and will be sent in the Authorization header for all subsequent webhook notifications to this endpoint.

string secret = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The secret.

getSecretBytes()

public abstract ByteString getSecretBytes()

Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer <token>" or "Basic <credentials>", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during CreateSubscriber and UpdateSubscriber calls, and will be sent in the Authorization header for all subsequent webhook notifications to this endpoint.

string secret = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for secret.

getSecretSet()

public abstract boolean getSecretSet()

Output only. Whether the secret is set.

bool secret_set = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The secretSet.