Interface InternalRangeOrBuilder (1.71.0) 

public interface InternalRangeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-defined labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAllocationOptions()

public abstract InternalRange.AllocationOptions getAllocationOptions()

Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).

.google.cloud.networkconnectivity.v1.InternalRange.AllocationOptions allocation_options = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.AllocationOptions

The allocationOptions.

getAllocationOptionsOrBuilder()

public abstract InternalRange.AllocationOptionsOrBuilder getAllocationOptionsOrBuilder()

Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).

.google.cloud.networkconnectivity.v1.InternalRange.AllocationOptions allocation_options = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.AllocationOptionsOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Time when the internal range was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Time when the internal range was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. A description of this resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A description of this resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getExcludeCidrRanges(int index)

public abstract String getExcludeCidrRanges(int index)

Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks

repeated string exclude_cidr_ranges = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The excludeCidrRanges at the given index.

getExcludeCidrRangesBytes(int index)

public abstract ByteString getExcludeCidrRangesBytes(int index)

Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks

repeated string exclude_cidr_ranges = 17 [(.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 excludeCidrRanges at the given index.

getExcludeCidrRangesCount()

public abstract int getExcludeCidrRangesCount()

Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks

repeated string exclude_cidr_ranges = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of excludeCidrRanges.

getExcludeCidrRangesList()

public abstract List<String> getExcludeCidrRangesList()

Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks

repeated string exclude_cidr_ranges = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the excludeCidrRanges.

getImmutable()

public abstract boolean getImmutable()

Optional. Immutable ranges cannot have their fields modified, except for labels and description.

bool immutable = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The immutable.

getIpCidrRange()

public abstract String getIpCidrRange()

Optional. The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.

string ip_cidr_range = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ipCidrRange.

getIpCidrRangeBytes()

public abstract ByteString getIpCidrRangeBytes()

Optional. The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.

string ip_cidr_range = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ipCidrRange.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-defined labels.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-defined labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getMigration()

public abstract InternalRange.Migration getMigration()

Optional. Must be present if usage is set to FOR_MIGRATION.

.google.cloud.networkconnectivity.v1.InternalRange.Migration migration = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.Migration

The migration.

getMigrationOrBuilder()

public abstract InternalRange.MigrationOrBuilder getMigrationOrBuilder()

Optional. Must be present if usage is set to FOR_MIGRATION.

.google.cloud.networkconnectivity.v1.InternalRange.Migration migration = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.MigrationOrBuilder

getName()

public abstract String getName()

Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public abstract String getNetwork()

Immutable. The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}

string network = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

Immutable. The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}

string network = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for network.

getOverlaps(int index)

public abstract InternalRange.Overlap getOverlaps(int index)

Optional. Types of resources that are allowed to overlap with the current internal range.

repeated .google.cloud.networkconnectivity.v1.InternalRange.Overlap overlaps = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
InternalRange.Overlap

The overlaps at the given index.

getOverlapsCount()

public abstract int getOverlapsCount()

Optional. Types of resources that are allowed to overlap with the current internal range.

repeated .google.cloud.networkconnectivity.v1.InternalRange.Overlap overlaps = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of overlaps.

getOverlapsList()

public abstract List<InternalRange.Overlap> getOverlapsList()

Optional. Types of resources that are allowed to overlap with the current internal range.

repeated .google.cloud.networkconnectivity.v1.InternalRange.Overlap overlaps = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Overlap>

A list containing the overlaps.

getOverlapsValue(int index)

public abstract int getOverlapsValue(int index)

Optional. Types of resources that are allowed to overlap with the current internal range.

repeated .google.cloud.networkconnectivity.v1.InternalRange.Overlap overlaps = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of overlaps at the given index.

getOverlapsValueList()

public abstract List<Integer> getOverlapsValueList()

Optional. Types of resources that are allowed to overlap with the current internal range.

repeated .google.cloud.networkconnectivity.v1.InternalRange.Overlap overlaps = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for overlaps.

getPeering()

public abstract InternalRange.Peering getPeering()

Optional. The type of peering set for this internal range.

.google.cloud.networkconnectivity.v1.InternalRange.Peering peering = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.Peering

The peering.

getPeeringValue()

public abstract int getPeeringValue()

Optional. The type of peering set for this internal range.

.google.cloud.networkconnectivity.v1.InternalRange.Peering peering = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for peering.

getPrefixLength()

public abstract int getPrefixLength()

Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.

int32 prefix_length = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The prefixLength.

getTargetCidrRange(int index)

public abstract String getTargetCidrRange(int index)

Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.

repeated string target_cidr_range = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The targetCidrRange at the given index.

getTargetCidrRangeBytes(int index)

public abstract ByteString getTargetCidrRangeBytes(int index)

Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.

repeated string target_cidr_range = 11 [(.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 targetCidrRange at the given index.

getTargetCidrRangeCount()

public abstract int getTargetCidrRangeCount()

Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.

repeated string target_cidr_range = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of targetCidrRange.

getTargetCidrRangeList()

public abstract List<String> getTargetCidrRangeList()

Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.

repeated string target_cidr_range = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the targetCidrRange.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Time when the internal range was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Time when the internal range was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
TimestampOrBuilder

getUsage()

public abstract InternalRange.Usage getUsage()

Optional. The type of usage set for this InternalRange.

.google.cloud.networkconnectivity.v1.InternalRange.Usage usage = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRange.Usage

The usage.

getUsageValue()

public abstract int getUsageValue()

Optional. The type of usage set for this InternalRange.

.google.cloud.networkconnectivity.v1.InternalRange.Usage usage = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for usage.

getUsers(int index)

public abstract String getUsers(int index)

Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

repeated string users = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The users at the given index.

getUsersBytes(int index)

public abstract ByteString getUsersBytes(int index)

Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

repeated string users = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the users at the given index.

getUsersCount()

public abstract int getUsersCount()

Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

repeated string users = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of users.

getUsersList()

public abstract List<String> getUsersList()

Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

repeated string users = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the users.

hasAllocationOptions()

public abstract boolean hasAllocationOptions()

Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).

.google.cloud.networkconnectivity.v1.InternalRange.AllocationOptions allocation_options = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the allocationOptions field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Time when the internal range was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasMigration()

public abstract boolean hasMigration()

Optional. Must be present if usage is set to FOR_MIGRATION.

.google.cloud.networkconnectivity.v1.InternalRange.Migration migration = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the migration field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Time when the internal range was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
boolean

Whether the updateTime field is set.