Class Plugin.ConfigTemplate.AuthConfigTemplate (0.28.0) 

public static final class Plugin.ConfigTemplate.AuthConfigTemplate extends GeneratedMessageV3 implements Plugin.ConfigTemplate.AuthConfigTemplateOrBuilder

AuthConfigTemplate represents the authentication template for a plugin.

Protobuf type google.cloud.apihub.v1.Plugin.ConfigTemplate.AuthConfigTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Plugin.ConfigTemplate.AuthConfigTemplate

Static Fields

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_AUTH_TYPES_FIELD_NUMBER

public static final int SUPPORTED_AUTH_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Plugin.ConfigTemplate.AuthConfigTemplate getDefaultInstance()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate

getDescriptor()

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

newBuilder()

public static Plugin.ConfigTemplate.AuthConfigTemplate.Builder newBuilder()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

newBuilder(Plugin.ConfigTemplate.AuthConfigTemplate prototype)

public static Plugin.ConfigTemplate.AuthConfigTemplate.Builder newBuilder(Plugin.ConfigTemplate.AuthConfigTemplate prototype)
Parameter
Name Description
prototype Plugin.ConfigTemplate.AuthConfigTemplate
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

parseDelimitedFrom(InputStream input)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Plugin.ConfigTemplate.AuthConfigTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Plugin.ConfigTemplate.AuthConfigTemplate> parser()
Returns
Type Description
Parser<AuthConfigTemplate>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Plugin.ConfigTemplate.AuthConfigTemplate getDefaultInstanceForType()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate

getParserForType()

public Parser<Plugin.ConfigTemplate.AuthConfigTemplate> getParserForType()
Returns
Type Description
Parser<AuthConfigTemplate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public GoogleServiceAccountConfig getServiceAccount()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleServiceAccountConfig

The serviceAccount.

getServiceAccountOrBuilder()

public GoogleServiceAccountConfigOrBuilder getServiceAccountOrBuilder()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleServiceAccountConfigOrBuilder

getSupportedAuthTypes(int index)

public AuthType getSupportedAuthTypes(int index)

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
AuthType

The supportedAuthTypes at the given index.

getSupportedAuthTypesCount()

public int getSupportedAuthTypesCount()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of supportedAuthTypes.

getSupportedAuthTypesList()

public List<AuthType> getSupportedAuthTypesList()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<AuthType>

A list containing the supportedAuthTypes.

getSupportedAuthTypesValue(int index)

public int getSupportedAuthTypesValue(int index)

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of supportedAuthTypes at the given index.

getSupportedAuthTypesValueList()

public List<Integer> getSupportedAuthTypesValueList()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedAuthTypes.

hasServiceAccount()

public boolean hasServiceAccount()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serviceAccount field is set.

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 Plugin.ConfigTemplate.AuthConfigTemplate.Builder newBuilderForType()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Plugin.ConfigTemplate.AuthConfigTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder toBuilder()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

writeTo(CodedOutputStream output)

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