Class Pipeline.Destination.AuthenticationConfig.OAuthToken (1.55.0)

public static final class Pipeline.Destination.AuthenticationConfig.OAuthToken extends GeneratedMessageV3 implements Pipeline.Destination.AuthenticationConfig.OAuthTokenOrBuilder

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Protobuf type google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OAuthToken

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Pipeline.Destination.AuthenticationConfig.OAuthToken

Static Fields

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Pipeline.Destination.AuthenticationConfig.OAuthToken getDefaultInstance()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder newBuilder()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

newBuilder(Pipeline.Destination.AuthenticationConfig.OAuthToken prototype)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder newBuilder(Pipeline.Destination.AuthenticationConfig.OAuthToken prototype)
Parameter
Name Description
prototype Pipeline.Destination.AuthenticationConfig.OAuthToken
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OAuthToken parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Pipeline.Destination.AuthenticationConfig.OAuthToken> parser()
Returns
Type Description
Parser<OAuthToken>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Pipeline.Destination.AuthenticationConfig.OAuthToken getDefaultInstanceForType()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken

getParserForType()

public Parser<Pipeline.Destination.AuthenticationConfig.OAuthToken> getParserForType()
Returns
Type Description
Parser<OAuthToken>
Overrides

getScope()

public String getScope()

Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for scope.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for serviceAccount.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder newBuilderForType()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder toBuilder()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException