Package com.google.cloud.networkconnectivity.v1beta

Interface RouteOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Route, Route.Builder
@Generated public interface RouteOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Immutable. The name of the route. Route names must be unique. Route names
 use the following form:
 `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
      string name = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Immutable. The name of the route. Route names must be unique. Route names
 use the following form:
 `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
      string name = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time the route was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time the route was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time the route was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time the route was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time the route was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time the route was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getIpCidrRange

      String getIpCidrRange()
       The destination IP address range.
      string ip_cidr_range = 1;
      Returns:
      The ipCidrRange.

    • getIpCidrRangeBytes

      com.google.protobuf.ByteString getIpCidrRangeBytes()
       The destination IP address range.
      string ip_cidr_range = 1;
      Returns:
      The bytes for ipCidrRange.

    • getTypeValue

      int getTypeValue()
       Output only. The route's type. Its type is determined by the properties of
 its IP address range.
      .google.cloud.networkconnectivity.v1beta.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      RouteType getType()
       Output only. The route's type. Its type is determined by the properties of
 its IP address range.
      .google.cloud.networkconnectivity.v1beta.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The type.

    • hasNextHopVpcNetwork

      boolean hasNextHopVpcNetwork()
       Immutable. The destination VPC network for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the nextHopVpcNetwork field is set.

    • getNextHopVpcNetwork

      NextHopVpcNetwork getNextHopVpcNetwork()
       Immutable. The destination VPC network for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The nextHopVpcNetwork.

    • getNextHopVpcNetworkOrBuilder

      NextHopVpcNetworkOrBuilder getNextHopVpcNetworkOrBuilder()
       Immutable. The destination VPC network for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

    • getLabelsCount

      int getLabelsCount()
       Optional labels in key-value pair format. For more information about
 labels, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
      map<string, string> labels = 6;

    • containsLabels

      boolean containsLabels(String key)
       Optional labels in key-value pair format. For more information about
 labels, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
      map<string, string> labels = 6;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional labels in key-value pair format. For more information about
 labels, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
      map<string, string> labels = 6;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional labels in key-value pair format. For more information about
 labels, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
      map<string, string> labels = 6;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional labels in key-value pair format. For more information about
 labels, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
      map<string, string> labels = 6;

    • getDescription

      String getDescription()
       An optional description of the route.
      string description = 7;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of the route.
      string description = 7;
      Returns:
      The bytes for description.

    • getUid

      String getUid()
       Output only. The Google-generated UUID for the route. This value is unique
 across all Network Connectivity Center route resources. If a
 route is deleted and another with the same name is created,
 the new route is assigned a different `uid`.
      string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The uid.

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. The Google-generated UUID for the route. This value is unique
 across all Network Connectivity Center route resources. If a
 route is deleted and another with the same name is created,
 the new route is assigned a different `uid`.
      string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.

    • getStateValue

      int getStateValue()
       Output only. The current lifecycle state of the route.
      .google.cloud.networkconnectivity.v1beta.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      State getState()
       Output only. The current lifecycle state of the route.
      .google.cloud.networkconnectivity.v1beta.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getSpoke

      String getSpoke()
       Immutable. The spoke that this route leads to.
 Example: projects/12345/locations/global/spokes/SPOKE
      string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The spoke.

    • getSpokeBytes

      com.google.protobuf.ByteString getSpokeBytes()
       Immutable. The spoke that this route leads to.
 Example: projects/12345/locations/global/spokes/SPOKE
      string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for spoke.

    • getLocation

      String getLocation()
       Output only. The origin location of the route.
 Uses the following form: "projects/{project}/locations/{location}"
 Example: projects/1234/locations/us-central1
      string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Output only. The origin location of the route.
 Uses the following form: "projects/{project}/locations/{location}"
 Example: projects/1234/locations/us-central1
      string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for location.

    • getPriority

      long getPriority()
       Output only. The priority of this route. Priority is used to break ties in
 cases where a destination matches more than one route. In these cases the
 route with the lowest-numbered priority value wins.
      int64 priority = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The priority.

    • hasNextHopVpnTunnel

      boolean hasNextHopVpnTunnel()
       Immutable. The next-hop VPN tunnel for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the nextHopVpnTunnel field is set.

    • getNextHopVpnTunnel

      NextHopVPNTunnel getNextHopVpnTunnel()
       Immutable. The next-hop VPN tunnel for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The nextHopVpnTunnel.

    • getNextHopVpnTunnelOrBuilder

      NextHopVPNTunnelOrBuilder getNextHopVpnTunnelOrBuilder()
       Immutable. The next-hop VPN tunnel for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

    • hasNextHopRouterApplianceInstance

      boolean hasNextHopRouterApplianceInstance()
       Immutable. The next-hop Router appliance instance for packets on this
 route.
      .google.cloud.networkconnectivity.v1beta.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the nextHopRouterApplianceInstance field is set.

    • getNextHopRouterApplianceInstance

      NextHopRouterApplianceInstance getNextHopRouterApplianceInstance()
       Immutable. The next-hop Router appliance instance for packets on this
 route.
      .google.cloud.networkconnectivity.v1beta.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The nextHopRouterApplianceInstance.

    • getNextHopRouterApplianceInstanceOrBuilder

      NextHopRouterApplianceInstanceOrBuilder getNextHopRouterApplianceInstanceOrBuilder()
       Immutable. The next-hop Router appliance instance for packets on this
 route.
      .google.cloud.networkconnectivity.v1beta.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

    • hasNextHopInterconnectAttachment

      boolean hasNextHopInterconnectAttachment()
       Immutable. The next-hop VLAN attachment for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the nextHopInterconnectAttachment field is set.

    • getNextHopInterconnectAttachment

      NextHopInterconnectAttachment getNextHopInterconnectAttachment()
       Immutable. The next-hop VLAN attachment for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The nextHopInterconnectAttachment.

    • getNextHopInterconnectAttachmentOrBuilder

      NextHopInterconnectAttachmentOrBuilder getNextHopInterconnectAttachmentOrBuilder()
       Immutable. The next-hop VLAN attachment for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

    • hasNextHopSpoke

      boolean hasNextHopSpoke()
       Immutable. The next-hop spoke for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopSpoke next_hop_spoke = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the nextHopSpoke field is set.

    • getNextHopSpoke

      NextHopSpoke getNextHopSpoke()
       Immutable. The next-hop spoke for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopSpoke next_hop_spoke = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The nextHopSpoke.

    • getNextHopSpokeOrBuilder

      NextHopSpokeOrBuilder getNextHopSpokeOrBuilder()
       Immutable. The next-hop spoke for packets on this route.
      .google.cloud.networkconnectivity.v1beta.NextHopSpoke next_hop_spoke = 18 [(.google.api.field_behavior) = IMMUTABLE];