Class ServicePerimeterConfig.EgressTo (1.45.0)

public static final class ServicePerimeterConfig.EgressTo extends GeneratedMessageV3 implements ServicePerimeterConfig.EgressToOrBuilder

Defines the conditions under which an [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] matches a request. Conditions are based on information about the [ApiOperation] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] intended to be performed on the resources specified. Note that if the destination of the request is also protected by a [ServicePerimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter], then that [ServicePerimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] must have an [IngressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] which allows access in order for this request to succeed. The request must match operations AND resources fields in order to be allowed egress out of the perimeter.

Protobuf type google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServicePerimeterConfig.EgressTo

Static Fields

EXTERNAL_RESOURCES_FIELD_NUMBER

public static final int EXTERNAL_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

OPERATIONS_FIELD_NUMBER

public static final int OPERATIONS_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServicePerimeterConfig.EgressTo getDefaultInstance()
Returns
Type Description
ServicePerimeterConfig.EgressTo

getDescriptor()

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

newBuilder()

public static ServicePerimeterConfig.EgressTo.Builder newBuilder()
Returns
Type Description
ServicePerimeterConfig.EgressTo.Builder

newBuilder(ServicePerimeterConfig.EgressTo prototype)

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

parseDelimitedFrom(InputStream input)

public static ServicePerimeterConfig.EgressTo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServicePerimeterConfig.EgressTo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ServicePerimeterConfig.EgressTo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ServicePerimeterConfig.EgressTo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ServicePerimeterConfig.EgressTo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ServicePerimeterConfig.EgressTo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServicePerimeterConfig.EgressTo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ServicePerimeterConfig.EgressTo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ServicePerimeterConfig.EgressTo> parser()
Returns
Type Description
Parser<EgressTo>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ServicePerimeterConfig.EgressTo getDefaultInstanceForType()
Returns
Type Description
ServicePerimeterConfig.EgressTo

getExternalResources(int index)

public String getExternalResources(int index)

A list of external resources that are allowed to be accessed. Only AWS and Azure resources are supported. For Amazon S3, the supported format is s3://BUCKET_NAME. For Azure Storage, the supported format is azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed.

repeated string external_resources = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The externalResources at the given index.

getExternalResourcesBytes(int index)

public ByteString getExternalResourcesBytes(int index)

A list of external resources that are allowed to be accessed. Only AWS and Azure resources are supported. For Amazon S3, the supported format is s3://BUCKET_NAME. For Azure Storage, the supported format is azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed.

repeated string external_resources = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the externalResources at the given index.

getExternalResourcesCount()

public int getExternalResourcesCount()

A list of external resources that are allowed to be accessed. Only AWS and Azure resources are supported. For Amazon S3, the supported format is s3://BUCKET_NAME. For Azure Storage, the supported format is azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed.

repeated string external_resources = 3;

Returns
Type Description
int

The count of externalResources.

getExternalResourcesList()

public ProtocolStringList getExternalResourcesList()

A list of external resources that are allowed to be accessed. Only AWS and Azure resources are supported. For Amazon S3, the supported format is s3://BUCKET_NAME. For Azure Storage, the supported format is azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed.

repeated string external_resources = 3;

Returns
Type Description
ProtocolStringList

A list containing the externalResources.

getOperations(int index)

public ServicePerimeterConfig.ApiOperation getOperations(int index)

A list of [ApiOperations] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] allowed to be performed by the sources specified in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it uses an operation/service in this list.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation operations = 2;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.ApiOperation

getOperationsCount()

public int getOperationsCount()

A list of [ApiOperations] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] allowed to be performed by the sources specified in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it uses an operation/service in this list.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation operations = 2;

Returns
Type Description
int

getOperationsList()

public List<ServicePerimeterConfig.ApiOperation> getOperationsList()

A list of [ApiOperations] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] allowed to be performed by the sources specified in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it uses an operation/service in this list.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation operations = 2;

Returns
Type Description
List<ApiOperation>

getOperationsOrBuilder(int index)

public ServicePerimeterConfig.ApiOperationOrBuilder getOperationsOrBuilder(int index)

A list of [ApiOperations] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] allowed to be performed by the sources specified in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it uses an operation/service in this list.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation operations = 2;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.ApiOperationOrBuilder

getOperationsOrBuilderList()

public List<? extends ServicePerimeterConfig.ApiOperationOrBuilder> getOperationsOrBuilderList()

A list of [ApiOperations] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] allowed to be performed by the sources specified in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it uses an operation/service in this list.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation operations = 2;

Returns
Type Description
List<? extends com.google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperationOrBuilder>

getParserForType()

public Parser<ServicePerimeterConfig.EgressTo> getParserForType()
Returns
Type Description
Parser<EgressTo>
Overrides

getResources(int index)

public String getResources(int index)

A list of resources, currently only projects in the form projects/<projectnumber>, that are allowed to be accessed by sources defined in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it contains a resource in this list. If * is specified for resources, then this [EgressTo] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] rule will authorize access to all resources outside the perimeter.

repeated string resources = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resources at the given index.

getResourcesBytes(int index)

public ByteString getResourcesBytes(int index)

A list of resources, currently only projects in the form projects/<projectnumber>, that are allowed to be accessed by sources defined in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it contains a resource in this list. If * is specified for resources, then this [EgressTo] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] rule will authorize access to all resources outside the perimeter.

repeated string resources = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resources at the given index.

getResourcesCount()

public int getResourcesCount()

A list of resources, currently only projects in the form projects/<projectnumber>, that are allowed to be accessed by sources defined in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it contains a resource in this list. If * is specified for resources, then this [EgressTo] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] rule will authorize access to all resources outside the perimeter.

repeated string resources = 1;

Returns
Type Description
int

The count of resources.

getResourcesList()

public ProtocolStringList getResourcesList()

A list of resources, currently only projects in the form projects/<projectnumber>, that are allowed to be accessed by sources defined in the corresponding [EgressFrom] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. A request matches if it contains a resource in this list. If * is specified for resources, then this [EgressTo] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] rule will authorize access to all resources outside the perimeter.

repeated string resources = 1;

Returns
Type Description
ProtocolStringList

A list containing the resources.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ServicePerimeterConfig.EgressTo.Builder newBuilderForType()
Returns
Type Description
ServicePerimeterConfig.EgressTo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServicePerimeterConfig.EgressTo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServicePerimeterConfig.EgressTo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ServicePerimeterConfig.EgressTo.Builder toBuilder()
Returns
Type Description
ServicePerimeterConfig.EgressTo.Builder

writeTo(CodedOutputStream output)

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