public static final class ChannelProfile.WebWidgetConfig.SecuritySettings.Builder extends GeneratedMessage.Builder<ChannelProfile.WebWidgetConfig.SecuritySettings.Builder> implements ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilderSecurity settings for the web widget.
Protobuf type google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.SecuritySettings
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ChannelProfile.WebWidgetConfig.SecuritySettings.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllAllowedOrigins(Iterable<String> values)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder addAllAllowedOrigins(Iterable<String> values)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The allowedOrigins to add. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
addAllowedOrigins(String value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder addAllowedOrigins(String value)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe allowedOrigins to add. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
addAllowedOriginsBytes(ByteString value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder addAllowedOriginsBytes(ByteString value)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the allowedOrigins to add. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
build()
public ChannelProfile.WebWidgetConfig.SecuritySettings build()| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings |
|
buildPartial()
public ChannelProfile.WebWidgetConfig.SecuritySettings buildPartial()| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings |
|
clear()
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder clear()| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
|
clearAllowedOrigins()
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder clearAllowedOrigins()Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
clearEnableOriginCheck()
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder clearEnableOriginCheck() Optional. Indicates whether origin check for the web widget is enabled.
If true, the web widget will check the origin of the website that
loads the web widget and only allow it to be loaded in the same origin
or any of the allowed origins.
bool enable_origin_check = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
clearEnablePublicAccess()
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder clearEnablePublicAccess() Optional. Indicates whether public access to the web widget is enabled.
If true, the web widget will be publicly accessible.
If false, the web widget must be integrated with your own
authentication and authorization system to return valid credentials for
accessing the CES agent.
bool enable_public_access = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
clearEnableRecaptcha()
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder clearEnableRecaptcha()Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
bool enable_recaptcha = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
getAllowedOrigins(int index)
public String getAllowedOrigins(int index)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The allowedOrigins at the given index. |
getAllowedOriginsBytes(int index)
public ByteString getAllowedOriginsBytes(int index)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the allowedOrigins at the given index. |
getAllowedOriginsCount()
public int getAllowedOriginsCount()Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of allowedOrigins. |
getAllowedOriginsList()
public ProtocolStringList getAllowedOriginsList()Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the allowedOrigins. |
getDefaultInstanceForType()
public ChannelProfile.WebWidgetConfig.SecuritySettings getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEnableOriginCheck()
public boolean getEnableOriginCheck() Optional. Indicates whether origin check for the web widget is enabled.
If true, the web widget will check the origin of the website that
loads the web widget and only allow it to be loaded in the same origin
or any of the allowed origins.
bool enable_origin_check = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableOriginCheck. |
getEnablePublicAccess()
public boolean getEnablePublicAccess() Optional. Indicates whether public access to the web widget is enabled.
If true, the web widget will be publicly accessible.
If false, the web widget must be integrated with your own
authentication and authorization system to return valid credentials for
accessing the CES agent.
bool enable_public_access = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enablePublicAccess. |
getEnableRecaptcha()
public boolean getEnableRecaptcha()Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
bool enable_recaptcha = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableRecaptcha. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ChannelProfile.WebWidgetConfig.SecuritySettings other)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder mergeFrom(ChannelProfile.WebWidgetConfig.SecuritySettings other)| Parameter | |
|---|---|
| Name | Description |
other |
ChannelProfile.WebWidgetConfig.SecuritySettings |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
|
setAllowedOrigins(int index, String value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder setAllowedOrigins(int index, String value)Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe allowedOrigins to set. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
setEnableOriginCheck(boolean value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder setEnableOriginCheck(boolean value) Optional. Indicates whether origin check for the web widget is enabled.
If true, the web widget will check the origin of the website that
loads the web widget and only allow it to be loaded in the same origin
or any of the allowed origins.
bool enable_origin_check = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableOriginCheck to set. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
setEnablePublicAccess(boolean value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder setEnablePublicAccess(boolean value) Optional. Indicates whether public access to the web widget is enabled.
If true, the web widget will be publicly accessible.
If false, the web widget must be integrated with your own
authentication and authorization system to return valid credentials for
accessing the CES agent.
bool enable_public_access = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enablePublicAccess to set. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |
setEnableRecaptcha(boolean value)
public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder setEnableRecaptcha(boolean value)Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
bool enable_recaptcha = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableRecaptcha to set. |
| Returns | |
|---|---|
| Type | Description |
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder |
This builder for chaining. |