public static final class GcipSettings.Builder extends GeneratedMessage.Builder<GcipSettings.Builder> implements GcipSettingsOrBuilderAllows customers to configure tenant IDs for a Cloud Identity Platform (GCIP) instance for each application.
Protobuf type google.cloud.iap.v1.GcipSettings
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GcipSettings.BuilderImplements
GcipSettingsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllTenantIds(Iterable<String> values)
public GcipSettings.Builder addAllTenantIds(Iterable<String> values) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The tenantIds to add. |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
This builder for chaining. |
addTenantIds(String value)
public GcipSettings.Builder addTenantIds(String value) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe tenantIds to add. |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
This builder for chaining. |
addTenantIdsBytes(ByteString value)
public GcipSettings.Builder addTenantIdsBytes(ByteString value) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the tenantIds to add. |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
This builder for chaining. |
build()
public GcipSettings build()| Returns | |
|---|---|
| Type | Description |
GcipSettings |
|
buildPartial()
public GcipSettings buildPartial()| Returns | |
|---|---|
| Type | Description |
GcipSettings |
|
clear()
public GcipSettings.Builder clear()| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
clearLoginPageUri()
public GcipSettings.Builder clearLoginPageUri()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 |
GcipSettings.Builder |
|
clearTenantIds()
public GcipSettings.Builder clearTenantIds() Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public GcipSettings getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GcipSettings |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getLoginPageUriBuilder()
public StringValue.Builder getLoginPageUriBuilder()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 |
Builder |
|
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 |
|
getTenantIds(int index)
public String getTenantIds(int index) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The tenantIds at the given index. |
getTenantIdsBytes(int index)
public ByteString getTenantIdsBytes(int index) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the tenantIds at the given index. |
getTenantIdsCount()
public int getTenantIdsCount() Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of tenantIds. |
getTenantIdsList()
public ProtocolStringList getTenantIdsList() Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GcipSettings other)
public GcipSettings.Builder mergeFrom(GcipSettings other)| Parameter | |
|---|---|
| Name | Description |
other |
GcipSettings |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GcipSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GcipSettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
mergeLoginPageUri(StringValue value)
public GcipSettings.Builder mergeLoginPageUri(StringValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringValue |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
setLoginPageUri(StringValue value)
public GcipSettings.Builder setLoginPageUri(StringValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringValue |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
setLoginPageUri(StringValue.Builder builderForValue)
public GcipSettings.Builder setLoginPageUri(StringValue.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
|
setTenantIds(int index, String value)
public GcipSettings.Builder setTenantIds(int index, String value) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe tenantIds to set. |
| Returns | |
|---|---|
| Type | Description |
GcipSettings.Builder |
This builder for chaining. |