Class GcipSettings (0.2.0)

public final class GcipSettings extends GeneratedMessageV3 implements GcipSettingsOrBuilder

Allows customers to configure tenant_id for GCIP instance per-app.

Protobuf type google.cloud.iap.v1.GcipSettings

Static Fields

LOGIN_PAGE_URI_FIELD_NUMBER

public static final int LOGIN_PAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

TENANT_IDS_FIELD_NUMBER

public static final int TENANT_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GcipSettings getDefaultInstance()
Returns
Type Description
GcipSettings

getDescriptor()

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

newBuilder()

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

newBuilder(GcipSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GcipSettings getDefaultInstanceForType()
Returns
Type Description
GcipSettings

getLoginPageUri()

public StringValue getLoginPageUri()

Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.

.google.protobuf.StringValue login_page_uri = 2;

Returns
Type Description
StringValue

The loginPageUri.

getLoginPageUriOrBuilder()

public StringValueOrBuilder getLoginPageUriOrBuilder()

Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.

.google.protobuf.StringValue login_page_uri = 2;

Returns
Type Description
StringValueOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTenantIds(int index)

public String getTenantIds(int index)

GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _<ProjectNumber> to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.

repeated string tenant_ids = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tenantIds at the given index.

getTenantIdsBytes(int index)

public ByteString getTenantIdsBytes(int index)

GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _<ProjectNumber> to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.

repeated string tenant_ids = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tenantIds at the given index.

getTenantIdsCount()

public int getTenantIdsCount()

GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _<ProjectNumber> to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.

repeated string tenant_ids = 1;

Returns
Type Description
int

The count of tenantIds.

getTenantIdsList()

public ProtocolStringList getTenantIdsList()

GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _<ProjectNumber> to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.

repeated string tenant_ids = 1;

Returns
Type Description
ProtocolStringList

A list containing the tenantIds.

hasLoginPageUri()

public boolean hasLoginPageUri()

Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.

.google.protobuf.StringValue login_page_uri = 2;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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