com.google.cloud.compute.v1.AddressOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-compute-v1 Show documentation
Show all versions of proto-google-cloud-compute-v1 Show documentation
Proto library for google-cloud-compute
The newest version!
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/compute/v1/compute.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.compute.v1;
public interface AddressOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.Address)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The static IP address represented by this resource.
*
*
* optional string address = 462920692;
*
* @return Whether the address field is set.
*/
boolean hasAddress();
/**
*
*
*
* The static IP address represented by this resource.
*
*
* optional string address = 462920692;
*
* @return The address.
*/
java.lang.String getAddress();
/**
*
*
*
* The static IP address represented by this resource.
*
*
* optional string address = 462920692;
*
* @return The bytes for address.
*/
com.google.protobuf.ByteString getAddressBytes();
/**
*
*
*
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
* Check the AddressType enum for the list of possible values.
*
*
* optional string address_type = 264307877;
*
* @return Whether the addressType field is set.
*/
boolean hasAddressType();
/**
*
*
*
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
* Check the AddressType enum for the list of possible values.
*
*
* optional string address_type = 264307877;
*
* @return The addressType.
*/
java.lang.String getAddressType();
/**
*
*
*
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
* Check the AddressType enum for the list of possible values.
*
*
* optional string address_type = 264307877;
*
* @return The bytes for addressType.
*/
com.google.protobuf.ByteString getAddressTypeBytes();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return Whether the creationTimestamp field is set.
*/
boolean hasCreationTimestamp();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return The creationTimestamp.
*/
java.lang.String getCreationTimestamp();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return The bytes for creationTimestamp.
*/
com.google.protobuf.ByteString getCreationTimestampBytes();
/**
*
*
*
* An optional description of this resource. Provide this field when you create the resource.
*
*
* optional string description = 422937596;
*
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
*
*
* An optional description of this resource. Provide this field when you create the resource.
*
*
* optional string description = 422937596;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* An optional description of this resource. Provide this field when you create the resource.
*
*
* optional string description = 422937596;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
*
*
* optional uint64 id = 3355;
*
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
*
*
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
*
*
* optional uint64 id = 3355;
*
* @return The id.
*/
long getId();
/**
*
*
*
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* Check the IpVersion enum for the list of possible values.
*
*
* optional string ip_version = 294959552;
*
* @return Whether the ipVersion field is set.
*/
boolean hasIpVersion();
/**
*
*
*
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* Check the IpVersion enum for the list of possible values.
*
*
* optional string ip_version = 294959552;
*
* @return The ipVersion.
*/
java.lang.String getIpVersion();
/**
*
*
*
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* Check the IpVersion enum for the list of possible values.
*
*
* optional string ip_version = 294959552;
*
* @return The bytes for ipVersion.
*/
com.google.protobuf.ByteString getIpVersionBytes();
/**
*
*
*
* The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
* Check the Ipv6EndpointType enum for the list of possible values.
*
*
* optional string ipv6_endpoint_type = 97501004;
*
* @return Whether the ipv6EndpointType field is set.
*/
boolean hasIpv6EndpointType();
/**
*
*
*
* The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
* Check the Ipv6EndpointType enum for the list of possible values.
*
*
* optional string ipv6_endpoint_type = 97501004;
*
* @return The ipv6EndpointType.
*/
java.lang.String getIpv6EndpointType();
/**
*
*
*
* The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
* Check the Ipv6EndpointType enum for the list of possible values.
*
*
* optional string ipv6_endpoint_type = 97501004;
*
* @return The bytes for ipv6EndpointType.
*/
com.google.protobuf.ByteString getIpv6EndpointTypeBytes();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#address for addresses.
*
*
* optional string kind = 3292052;
*
* @return Whether the kind field is set.
*/
boolean hasKind();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#address for addresses.
*
*
* optional string kind = 3292052;
*
* @return The kind.
*/
java.lang.String getKind();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#address for addresses.
*
*
* optional string kind = 3292052;
*
* @return The bytes for kind.
*/
com.google.protobuf.ByteString getKindBytes();
/**
*
*
*
* A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
*
*
* optional string label_fingerprint = 178124825;
*
* @return Whether the labelFingerprint field is set.
*/
boolean hasLabelFingerprint();
/**
*
*
*
* A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
*
*
* optional string label_fingerprint = 178124825;
*
* @return The labelFingerprint.
*/
java.lang.String getLabelFingerprint();
/**
*
*
*
* A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
*
*
* optional string label_fingerprint = 178124825;
*
* @return The bytes for labelFingerprint.
*/
com.google.protobuf.ByteString getLabelFingerprintBytes();
/**
*
*
*
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*
* map<string, string> labels = 500195327;
*/
int getLabelsCount();
/**
*
*
*
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*
* map<string, string> labels = 500195327;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*
* map<string, string> labels = 500195327;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*
* map<string, string> labels = 500195327;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*
* map<string, string> labels = 500195327;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
*
*
* optional string name = 3373707;
*
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
*
*
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
*
*
* optional string name = 3373707;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
*
*
* optional string name = 3373707;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
*
*
* optional string network = 232872494;
*
* @return Whether the network field is set.
*/
boolean hasNetwork();
/**
*
*
*
* The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
*
*
* optional string network = 232872494;
*
* @return The network.
*/
java.lang.String getNetwork();
/**
*
*
*
* The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
*
*
* optional string network = 232872494;
*
* @return The bytes for network.
*/
com.google.protobuf.ByteString getNetworkBytes();
/**
*
*
*
* This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
* Check the NetworkTier enum for the list of possible values.
*
*
* optional string network_tier = 517397843;
*
* @return Whether the networkTier field is set.
*/
boolean hasNetworkTier();
/**
*
*
*
* This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
* Check the NetworkTier enum for the list of possible values.
*
*
* optional string network_tier = 517397843;
*
* @return The networkTier.
*/
java.lang.String getNetworkTier();
/**
*
*
*
* This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
* Check the NetworkTier enum for the list of possible values.
*
*
* optional string network_tier = 517397843;
*
* @return The bytes for networkTier.
*/
com.google.protobuf.ByteString getNetworkTierBytes();
/**
*
*
*
* The prefix length if the resource represents an IP range.
*
*
* optional int32 prefix_length = 453565747;
*
* @return Whether the prefixLength field is set.
*/
boolean hasPrefixLength();
/**
*
*
*
* The prefix length if the resource represents an IP range.
*
*
* optional int32 prefix_length = 453565747;
*
* @return The prefixLength.
*/
int getPrefixLength();
/**
*
*
*
* The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
* Check the Purpose enum for the list of possible values.
*
*
* optional string purpose = 316407070;
*
* @return Whether the purpose field is set.
*/
boolean hasPurpose();
/**
*
*
*
* The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
* Check the Purpose enum for the list of possible values.
*
*
* optional string purpose = 316407070;
*
* @return The purpose.
*/
java.lang.String getPurpose();
/**
*
*
*
* The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
* Check the Purpose enum for the list of possible values.
*
*
* optional string purpose = 316407070;
*
* @return The bytes for purpose.
*/
com.google.protobuf.ByteString getPurposeBytes();
/**
*
*
*
* [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
*
*
* optional string region = 138946292;
*
* @return Whether the region field is set.
*/
boolean hasRegion();
/**
*
*
*
* [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
*
*
* optional string region = 138946292;
*
* @return The region.
*/
java.lang.String getRegion();
/**
*
*
*
* [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
*
*
* optional string region = 138946292;
*
* @return The bytes for region.
*/
com.google.protobuf.ByteString getRegionBytes();
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return Whether the selfLink field is set.
*/
boolean hasSelfLink();
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return The selfLink.
*/
java.lang.String getSelfLink();
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return The bytes for selfLink.
*/
com.google.protobuf.ByteString getSelfLinkBytes();
/**
*
*
*
* [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
* Check the Status enum for the list of possible values.
*
*
* optional string status = 181260274;
*
* @return Whether the status field is set.
*/
boolean hasStatus();
/**
*
*
*
* [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
* Check the Status enum for the list of possible values.
*
*
* optional string status = 181260274;
*
* @return The status.
*/
java.lang.String getStatus();
/**
*
*
*
* [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
* Check the Status enum for the list of possible values.
*
*
* optional string status = 181260274;
*
* @return The bytes for status.
*/
com.google.protobuf.ByteString getStatusBytes();
/**
*
*
*
* The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
*
*
* optional string subnetwork = 307827694;
*
* @return Whether the subnetwork field is set.
*/
boolean hasSubnetwork();
/**
*
*
*
* The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
*
*
* optional string subnetwork = 307827694;
*
* @return The subnetwork.
*/
java.lang.String getSubnetwork();
/**
*
*
*
* The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
*
*
* optional string subnetwork = 307827694;
*
* @return The bytes for subnetwork.
*/
com.google.protobuf.ByteString getSubnetworkBytes();
/**
*
*
*
* [Output Only] The URLs of the resources that are using this address.
*
*
* repeated string users = 111578632;
*
* @return A list containing the users.
*/
java.util.List getUsersList();
/**
*
*
*
* [Output Only] The URLs of the resources that are using this address.
*
*
* repeated string users = 111578632;
*
* @return The count of users.
*/
int getUsersCount();
/**
*
*
*
* [Output Only] The URLs of the resources that are using this address.
*
*
* repeated string users = 111578632;
*
* @param index The index of the element to return.
* @return The users at the given index.
*/
java.lang.String getUsers(int index);
/**
*
*
*
* [Output Only] The URLs of the resources that are using this address.
*
*
* repeated string users = 111578632;
*
* @param index The index of the value to return.
* @return The bytes of the users at the given index.
*/
com.google.protobuf.ByteString getUsersBytes(int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy