Class: Google::Cloud::NetworkConnectivity::V1::ListHubSpokesRequest

Inherits:

Object

• Object
• Google::Cloud::NetworkConnectivity::V1::ListHubSpokesRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/networkconnectivity/v1/hub.rb

Overview

The request for HubService.ListHubSpokes.

Defined Under Namespace

Modules: SpokeView

Instance Attribute Summary

• #filter ⇒ ::String

  An expression that filters the list of results.

• #name ⇒ ::String

  Required.

• #order_by ⇒ ::String

  Sort the results by name or create_time.

• #page_size ⇒ ::Integer

  The maximum number of results to return per page.

• #page_token ⇒ ::String

  The page token.

• #spoke_locations ⇒ ::Array<::String>

  A list of locations.

• #view ⇒ ::Google::Cloud::NetworkConnectivity::V1::ListHubSpokesRequest::SpokeView

  The view of the spoke to return.

Instance Attribute Details

#filter ⇒ ::String

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#name ⇒ ::String

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#order_by ⇒ ::String

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#page_size ⇒ ::Integer

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#page_token ⇒ ::String

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#spoke_locations ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end

#view ⇒ ::Google::Cloud::NetworkConnectivity::V1::ListHubSpokesRequest::SpokeView

# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 623

class ListHubSpokesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that controls which spoke fields are included in the response.
  module SpokeView
    # The spoke view is unspecified. When the spoke view is unspecified, the
    # API returns the same fields as the `BASIC` view.
    SPOKE_VIEW_UNSPECIFIED = 0

    # Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`,
    # and `spoke_type`. This is the default value.
    BASIC = 1

    # Includes all spoke fields except `labels`.
    # You can use the `DETAILED` view only when you set the `spoke_locations`
    # field to `[global]`.
    DETAILED = 2
  end
end