Class ChannelProfile.WebWidgetConfig.SecuritySettings.Builder (0.1.0)

public static final class ChannelProfile.WebWidgetConfig.SecuritySettings.Builder extends GeneratedMessage.Builder<ChannelProfile.WebWidgetConfig.SecuritySettings.Builder> implements ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilder

Security 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.Builder

Implements

ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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	String The 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	ByteString The 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

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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	int The 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	int The 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

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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	int The index to set the value at.
value	String The 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	boolean The 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	boolean The 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	boolean The enableRecaptcha to set.

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder	This builder for chaining.