Class ServicePerimeterConfig (1.48.0)

public final class ServicePerimeterConfig extends GeneratedMessageV3 implements ServicePerimeterConfigOrBuilder

ServicePerimeterConfig specifies a set of Google Cloud resources that describe specific Service Perimeter configuration.

Protobuf type google.identity.accesscontextmanager.v1.ServicePerimeterConfig

Static Fields

ACCESS_LEVELS_FIELD_NUMBER

public static final int ACCESS_LEVELS_FIELD_NUMBER
Field Value
Type Description
int

EGRESS_POLICIES_FIELD_NUMBER

public static final int EGRESS_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

INGRESS_POLICIES_FIELD_NUMBER

public static final int INGRESS_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

RESTRICTED_SERVICES_FIELD_NUMBER

public static final int RESTRICTED_SERVICES_FIELD_NUMBER
Field Value
Type Description
int

VPC_ACCESSIBLE_SERVICES_FIELD_NUMBER

public static final int VPC_ACCESSIBLE_SERVICES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServicePerimeterConfig getDefaultInstance()
Returns
Type Description
ServicePerimeterConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ServicePerimeterConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAccessLevels(int index)

public String getAccessLevels(int index)

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

repeated string access_levels = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The accessLevels at the given index.

getAccessLevelsBytes(int index)

public ByteString getAccessLevelsBytes(int index)

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

repeated string access_levels = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the accessLevels at the given index.

getAccessLevelsCount()

public int getAccessLevelsCount()

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

repeated string access_levels = 2;

Returns
Type Description
int

The count of accessLevels.

getAccessLevelsList()

public ProtocolStringList getAccessLevelsList()

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

repeated string access_levels = 2;

Returns
Type Description
ProtocolStringList

A list containing the accessLevels.

getDefaultInstanceForType()

public ServicePerimeterConfig getDefaultInstanceForType()
Returns
Type Description
ServicePerimeterConfig

getEgressPolicies(int index)

public ServicePerimeterConfig.EgressPolicy getEgressPolicies(int index)

List of [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] to apply to the perimeter. A perimeter may have multiple [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy], each of which is evaluated separately. Access is granted if any [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy egress_policies = 9;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.EgressPolicy

getEgressPoliciesCount()

public int getEgressPoliciesCount()

List of [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] to apply to the perimeter. A perimeter may have multiple [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy], each of which is evaluated separately. Access is granted if any [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy egress_policies = 9;

Returns
Type Description
int

getEgressPoliciesList()

public List<ServicePerimeterConfig.EgressPolicy> getEgressPoliciesList()

List of [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] to apply to the perimeter. A perimeter may have multiple [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy], each of which is evaluated separately. Access is granted if any [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy egress_policies = 9;

Returns
Type Description
List<EgressPolicy>

getEgressPoliciesOrBuilder(int index)

public ServicePerimeterConfig.EgressPolicyOrBuilder getEgressPoliciesOrBuilder(int index)

List of [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] to apply to the perimeter. A perimeter may have multiple [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy], each of which is evaluated separately. Access is granted if any [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy egress_policies = 9;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.EgressPolicyOrBuilder

getEgressPoliciesOrBuilderList()

public List<? extends ServicePerimeterConfig.EgressPolicyOrBuilder> getEgressPoliciesOrBuilderList()

List of [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] to apply to the perimeter. A perimeter may have multiple [EgressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy], each of which is evaluated separately. Access is granted if any [EgressPolicy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy egress_policies = 9;

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

getIngressPolicies(int index)

public ServicePerimeterConfig.IngressPolicy getIngressPolicies(int index)

List of [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] to apply to the perimeter. A perimeter may have multiple [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy], each of which is evaluated separately. Access is granted if any [Ingress Policy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy ingress_policies = 8;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.IngressPolicy

getIngressPoliciesCount()

public int getIngressPoliciesCount()

List of [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] to apply to the perimeter. A perimeter may have multiple [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy], each of which is evaluated separately. Access is granted if any [Ingress Policy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy ingress_policies = 8;

Returns
Type Description
int

getIngressPoliciesList()

public List<ServicePerimeterConfig.IngressPolicy> getIngressPoliciesList()

List of [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] to apply to the perimeter. A perimeter may have multiple [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy], each of which is evaluated separately. Access is granted if any [Ingress Policy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy ingress_policies = 8;

Returns
Type Description
List<IngressPolicy>

getIngressPoliciesOrBuilder(int index)

public ServicePerimeterConfig.IngressPolicyOrBuilder getIngressPoliciesOrBuilder(int index)

List of [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] to apply to the perimeter. A perimeter may have multiple [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy], each of which is evaluated separately. Access is granted if any [Ingress Policy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy ingress_policies = 8;

Parameter
Name Description
index int
Returns
Type Description
ServicePerimeterConfig.IngressPolicyOrBuilder

getIngressPoliciesOrBuilderList()

public List<? extends ServicePerimeterConfig.IngressPolicyOrBuilder> getIngressPoliciesOrBuilderList()

List of [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] to apply to the perimeter. A perimeter may have multiple [IngressPolicies] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy], each of which is evaluated separately. Access is granted if any [Ingress Policy] [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] grants it. Must be empty for a perimeter bridge.

repeated .google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy ingress_policies = 8;

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

getParserForType()

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

getResources(int index)

public String getResources(int index)

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

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 Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

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 Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

repeated string resources = 1;

Returns
Type Description
int

The count of resources.

getResourcesList()

public ProtocolStringList getResourcesList()

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

repeated string resources = 1;

Returns
Type Description
ProtocolStringList

A list containing the resources.

getRestrictedServices(int index)

public String getRestrictedServices(int index)

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

repeated string restricted_services = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The restrictedServices at the given index.

getRestrictedServicesBytes(int index)

public ByteString getRestrictedServicesBytes(int index)

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

repeated string restricted_services = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the restrictedServices at the given index.

getRestrictedServicesCount()

public int getRestrictedServicesCount()

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

repeated string restricted_services = 4;

Returns
Type Description
int

The count of restrictedServices.

getRestrictedServicesList()

public ProtocolStringList getRestrictedServicesList()

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

repeated string restricted_services = 4;

Returns
Type Description
ProtocolStringList

A list containing the restrictedServices.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVpcAccessibleServices()

public ServicePerimeterConfig.VpcAccessibleServices getVpcAccessibleServices()

Configuration for APIs allowed within Perimeter.

.google.identity.accesscontextmanager.v1.ServicePerimeterConfig.VpcAccessibleServices vpc_accessible_services = 10;

Returns
Type Description
ServicePerimeterConfig.VpcAccessibleServices

The vpcAccessibleServices.

getVpcAccessibleServicesOrBuilder()

public ServicePerimeterConfig.VpcAccessibleServicesOrBuilder getVpcAccessibleServicesOrBuilder()

Configuration for APIs allowed within Perimeter.

.google.identity.accesscontextmanager.v1.ServicePerimeterConfig.VpcAccessibleServices vpc_accessible_services = 10;

Returns
Type Description
ServicePerimeterConfig.VpcAccessibleServicesOrBuilder

hasVpcAccessibleServices()

public boolean hasVpcAccessibleServices()

Configuration for APIs allowed within Perimeter.

.google.identity.accesscontextmanager.v1.ServicePerimeterConfig.VpcAccessibleServices vpc_accessible_services = 10;

Returns
Type Description
boolean

Whether the vpcAccessibleServices field is set.

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.Builder newBuilderForType()
Returns
Type Description
ServicePerimeterConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServicePerimeterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServicePerimeterConfig.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.Builder toBuilder()
Returns
Type Description
ServicePerimeterConfig.Builder

writeTo(CodedOutputStream output)

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