Class ServicePerimeterConfig.EgressTo (1.24.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
TypeDescription
int

OPERATIONS_FIELD_NUMBER

public static final int OPERATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ServicePerimeterConfig.EgressTo getDefaultInstance()
Returns
TypeDescription
ServicePerimeterConfig.EgressTo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ServicePerimeterConfig.EgressTo.Builder newBuilder()
Returns
TypeDescription
ServicePerimeterConfig.EgressTo.Builder

newBuilder(ServicePerimeterConfig.EgressTo prototype)

public static ServicePerimeterConfig.EgressTo.Builder newBuilder(ServicePerimeterConfig.EgressTo prototype)
Parameter
NameDescription
prototypeServicePerimeterConfig.EgressTo
Returns
TypeDescription
ServicePerimeterConfig.EgressTo.Builder

parseDelimitedFrom(InputStream input)

public static ServicePerimeterConfig.EgressTo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ServicePerimeterConfig.EgressTo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServicePerimeterConfig.EgressTo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ServicePerimeterConfig.EgressTo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServicePerimeterConfig.EgressTo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServicePerimeterConfig.EgressTo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ServicePerimeterConfig.EgressTo getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperationOrBuilder>

getParserForType()

public Parser<ServicePerimeterConfig.EgressTo> getParserForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the resources.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ServicePerimeterConfig.EgressTo.Builder newBuilderForType()
Returns
TypeDescription
ServicePerimeterConfig.EgressTo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServicePerimeterConfig.EgressTo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ServicePerimeterConfig.EgressTo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ServicePerimeterConfig.EgressTo.Builder toBuilder()
Returns
TypeDescription
ServicePerimeterConfig.EgressTo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException