Package com.google.cloud.networkconnectivity.v1

Class Spoke

  • All Implemented Interfaces:
    SpokeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Spoke
extends com.google.protobuf.GeneratedMessageV3
implements SpokeOrBuilder
     A Network Connectivity Center spoke represents a connection between your
 Google Cloud network resources and a non-Google-Cloud network.

 When you create a spoke, you associate it with a hub. You must also identify
 a value for exactly one of the following fields:

 * linked_vpn_tunnels
 * linked_interconnect_attachments
 * linked_router_appliance_instances
    Protobuf type google.cloud.networkconnectivity.v1.Spoke
    See Also:
    Serialized Form

    • Field Detail

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LINKED_VPN_TUNNELS_FIELD_NUMBER

        public static final int LINKED_VPN_TUNNELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER

        public static final int LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER

        public static final int LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Immutable. The name of the spoke. Spoke names must be unique. They use the
 following form:
     `projects/{project_number}/locations/{region}/spokes/{spoke_id}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface SpokeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. The name of the spoke. Spoke names must be unique. They use the
 following form:
     `projects/{project_number}/locations/{region}/spokes/{spoke_id}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface SpokeOrBuilder
        Returns:
        The bytes for name.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time the spoke was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface SpokeOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time the spoke was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface SpokeOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time the spoke was created.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface SpokeOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time the spoke was last updated.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface SpokeOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time the spoke was last updated.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface SpokeOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time the spoke was last updated.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface SpokeOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: SpokeOrBuilder
         Optional labels in key:value 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 = 4;
        Specified by:
        getLabelsCount in interface SpokeOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional labels in key:value 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 = 4;
        Specified by:
        containsLabels in interface SpokeOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional labels in key:value 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 = 4;
        Specified by:
        getLabelsMap in interface SpokeOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional labels in key:value 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 = 4;
        Specified by:
        getLabelsOrDefault in interface SpokeOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional labels in key:value 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 = 4;
        Specified by:
        getLabelsOrThrow in interface SpokeOrBuilder

      • getDescription

        public String getDescription()
         An optional description of the spoke.
        string description = 5;
        Specified by:
        getDescription in interface SpokeOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of the spoke.
        string description = 5;
        Specified by:
        getDescriptionBytes in interface SpokeOrBuilder
        Returns:
        The bytes for description.

      • getHub

        public String getHub()
         Immutable. The name of the hub that this spoke is attached to.
        string hub = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getHub in interface SpokeOrBuilder
        Returns:
        The hub.

      • getHubBytes

        public com.google.protobuf.ByteString getHubBytes()
         Immutable. The name of the hub that this spoke is attached to.
        string hub = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getHubBytes in interface SpokeOrBuilder
        Returns:
        The bytes for hub.

      • hasLinkedVpnTunnels

        public boolean hasLinkedVpnTunnels()
         VPN tunnels that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;
        Specified by:
        hasLinkedVpnTunnels in interface SpokeOrBuilder
        Returns:
        Whether the linkedVpnTunnels field is set.

      • getLinkedVpnTunnels

        public LinkedVpnTunnels getLinkedVpnTunnels()
         VPN tunnels that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;
        Specified by:
        getLinkedVpnTunnels in interface SpokeOrBuilder
        Returns:
        The linkedVpnTunnels.

      • hasLinkedInterconnectAttachments

        public boolean hasLinkedInterconnectAttachments()
         VLAN attachments that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;
        Specified by:
        hasLinkedInterconnectAttachments in interface SpokeOrBuilder
        Returns:
        Whether the linkedInterconnectAttachments field is set.

      • getLinkedInterconnectAttachments

        public LinkedInterconnectAttachments getLinkedInterconnectAttachments()
         VLAN attachments that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;
        Specified by:
        getLinkedInterconnectAttachments in interface SpokeOrBuilder
        Returns:
        The linkedInterconnectAttachments.

      • hasLinkedRouterApplianceInstances

        public boolean hasLinkedRouterApplianceInstances()
         Router appliance instances that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;
        Specified by:
        hasLinkedRouterApplianceInstances in interface SpokeOrBuilder
        Returns:
        Whether the linkedRouterApplianceInstances field is set.

      • getLinkedRouterApplianceInstances

        public LinkedRouterApplianceInstances getLinkedRouterApplianceInstances()
         Router appliance instances that are associated with the spoke.
        .google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;
        Specified by:
        getLinkedRouterApplianceInstances in interface SpokeOrBuilder
        Returns:
        The linkedRouterApplianceInstances.

      • getUniqueId

        public String getUniqueId()
         Output only. The Google-generated UUID for the spoke. This value is unique
 across all spoke resources. If a spoke is deleted and another with the same
 name is created, the new spoke is assigned a different unique_id.
        string unique_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUniqueId in interface SpokeOrBuilder
        Returns:
        The uniqueId.

      • getUniqueIdBytes

        public com.google.protobuf.ByteString getUniqueIdBytes()
         Output only. The Google-generated UUID for the spoke. This value is unique
 across all spoke resources. If a spoke is deleted and another with the same
 name is created, the new spoke is assigned a different unique_id.
        string unique_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUniqueIdBytes in interface SpokeOrBuilder
        Returns:
        The bytes for uniqueId.

      • getStateValue

        public int getStateValue()
         Output only. The current lifecycle state of this spoke.
        .google.cloud.networkconnectivity.v1.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface SpokeOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public State getState()
         Output only. The current lifecycle state of this spoke.
        .google.cloud.networkconnectivity.v1.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface SpokeOrBuilder
        Returns:
        The state.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Spoke parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Spoke parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Spoke.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Spoke.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Spoke.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Spoke getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Spoke> parser()

      • getParserForType

        public com.google.protobuf.Parser<Spoke> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Spoke getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder