Class ChannelProfile.WebWidgetConfig.SecuritySettings (0.1.0)

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

Security settings for the web widget.

Protobuf type google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.SecuritySettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ChannelProfile.WebWidgetConfig.SecuritySettings

Implements

ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOWED_ORIGINS_FIELD_NUMBER

public static final int ALLOWED_ORIGINS_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_ORIGIN_CHECK_FIELD_NUMBER

public static final int ENABLE_ORIGIN_CHECK_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_PUBLIC_ACCESS_FIELD_NUMBER

public static final int ENABLE_PUBLIC_ACCESS_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_RECAPTCHA_FIELD_NUMBER

public static final int ENABLE_RECAPTCHA_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ChannelProfile.WebWidgetConfig.SecuritySettings getDefaultInstance()

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ChannelProfile.WebWidgetConfig.SecuritySettings.Builder newBuilder()

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder

newBuilder(ChannelProfile.WebWidgetConfig.SecuritySettings prototype)

public static ChannelProfile.WebWidgetConfig.SecuritySettings.Builder newBuilder(ChannelProfile.WebWidgetConfig.SecuritySettings prototype)

Parameter
Name	Description
prototype	ChannelProfile.WebWidgetConfig.SecuritySettings

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder

parseDelimitedFrom(InputStream input)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ChannelProfile.WebWidgetConfig.SecuritySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ChannelProfile.WebWidgetConfig.SecuritySettings> parser()

Returns
Type	Description
Parser<SecuritySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.

getParserForType()

public Parser<ChannelProfile.WebWidgetConfig.SecuritySettings> getParserForType()

Returns
Type	Description
Parser<SecuritySettings>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder newBuilderForType()

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ChannelProfile.WebWidgetConfig.SecuritySettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ChannelProfile.WebWidgetConfig.SecuritySettings.Builder toBuilder()

Returns
Type	Description
ChannelProfile.WebWidgetConfig.SecuritySettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException