Class EndpointControlPolicy (0.3.0)

public final class EndpointControlPolicy extends GeneratedMessage implements EndpointControlPolicyOrBuilder

Defines project/location level endpoint control policy.

Protobuf type google.cloud.ces.v1beta.EndpointControlPolicy

Static Fields

ALLOWED_ORIGINS_FIELD_NUMBER

public static final int ALLOWED_ORIGINS_FIELD_NUMBER
Field Value
Type Description
int

ENFORCEMENT_SCOPE_FIELD_NUMBER

public static final int ENFORCEMENT_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EndpointControlPolicy getDefaultInstance()
Returns
Type Description
EndpointControlPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(EndpointControlPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowedOrigins(int index)

public String getAllowedOrigins(int index)

Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".

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 allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".

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 allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of allowedOrigins.

getAllowedOriginsList()

public ProtocolStringList getAllowedOriginsList()

Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the allowedOrigins.

getDefaultInstanceForType()

public EndpointControlPolicy getDefaultInstanceForType()
Returns
Type Description
EndpointControlPolicy

getEnforcementScope()

public EndpointControlPolicy.EnforcementScope getEnforcementScope()

Optional. The scope in which this policy's allowed_origins list is enforced.

.google.cloud.ces.v1beta.EndpointControlPolicy.EnforcementScope enforcement_scope = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EndpointControlPolicy.EnforcementScope

The enforcementScope.

getEnforcementScopeValue()

public int getEnforcementScopeValue()

Optional. The scope in which this policy's allowed_origins list is enforced.

.google.cloud.ces.v1beta.EndpointControlPolicy.EnforcementScope enforcement_scope = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for enforcementScope.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EndpointControlPolicy.Builder newBuilderForType()
Returns
Type Description
EndpointControlPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EndpointControlPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EndpointControlPolicy.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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