Class WorkforceIdentitySettings (0.18.0)

public final class WorkforceIdentitySettings extends GeneratedMessageV3 implements WorkforceIdentitySettingsOrBuilder

WorkforceIdentitySettings allows customers to configure workforce pools and OAuth 2.0 settings to gate their applications using a third-party IdP with access control.

Protobuf type google.cloud.iap.v1.WorkforceIdentitySettings

Static Fields

OAUTH2_FIELD_NUMBER

public static final int OAUTH2_FIELD_NUMBER
Field Value
Type Description
int

WORKFORCE_POOLS_FIELD_NUMBER

public static final int WORKFORCE_POOLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkforceIdentitySettings getDefaultInstance()
Returns
Type Description
WorkforceIdentitySettings

getDescriptor()

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

newBuilder()

public static WorkforceIdentitySettings.Builder newBuilder()
Returns
Type Description
WorkforceIdentitySettings.Builder

newBuilder(WorkforceIdentitySettings prototype)

public static WorkforceIdentitySettings.Builder newBuilder(WorkforceIdentitySettings prototype)
Parameter
Name Description
prototype WorkforceIdentitySettings
Returns
Type Description
WorkforceIdentitySettings.Builder

parseDelimitedFrom(InputStream input)

public static WorkforceIdentitySettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WorkforceIdentitySettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkforceIdentitySettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkforceIdentitySettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WorkforceIdentitySettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WorkforceIdentitySettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkforceIdentitySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkforceIdentitySettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WorkforceIdentitySettings> parser()
Returns
Type Description
Parser<WorkforceIdentitySettings>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public WorkforceIdentitySettings getDefaultInstanceForType()
Returns
Type Description
WorkforceIdentitySettings

getOauth2()

public OAuth2 getOauth2()

OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.

.google.cloud.iap.v1.OAuth2 oauth2 = 2;

Returns
Type Description
OAuth2

The oauth2.

getOauth2OrBuilder()

public OAuth2OrBuilder getOauth2OrBuilder()

OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.

.google.cloud.iap.v1.OAuth2 oauth2 = 2;

Returns
Type Description
OAuth2OrBuilder

getParserForType()

public Parser<WorkforceIdentitySettings> getParserForType()
Returns
Type Description
Parser<WorkforceIdentitySettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWorkforcePools(int index)

public String getWorkforcePools(int index)

The workforce pool resources. Only one workforce pool is accepted.

repeated string workforce_pools = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The workforcePools at the given index.

getWorkforcePoolsBytes(int index)

public ByteString getWorkforcePoolsBytes(int index)

The workforce pool resources. Only one workforce pool is accepted.

repeated string workforce_pools = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the workforcePools at the given index.

getWorkforcePoolsCount()

public int getWorkforcePoolsCount()

The workforce pool resources. Only one workforce pool is accepted.

repeated string workforce_pools = 1;

Returns
Type Description
int

The count of workforcePools.

getWorkforcePoolsList()

public ProtocolStringList getWorkforcePoolsList()

The workforce pool resources. Only one workforce pool is accepted.

repeated string workforce_pools = 1;

Returns
Type Description
ProtocolStringList

A list containing the workforcePools.

hasOauth2()

public boolean hasOauth2()

OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.

.google.cloud.iap.v1.OAuth2 oauth2 = 2;

Returns
Type Description
boolean

Whether the oauth2 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 WorkforceIdentitySettings.Builder newBuilderForType()
Returns
Type Description
WorkforceIdentitySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkforceIdentitySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WorkforceIdentitySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public WorkforceIdentitySettings.Builder toBuilder()
Returns
Type Description
WorkforceIdentitySettings.Builder

writeTo(CodedOutputStream output)

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