Class: Google::Cloud::Location::Location

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/location/locations.rb

Overview

A resource that represents Google Cloud Platform location.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns The friendly name for this location, typically a nearby city name. For example, "Tokyo".

Returns:

  • (::String) —

    The friendly name for this location, typically a nearby city name. For example, "Tokyo".



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/location/locations.rb', line 83

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Cross-service attributes for the location. For example

{"cloud.googleapis.com/region": "us-east1"}.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Cross-service attributes for the location. For example

    {"cloud.googleapis.com/region": "us-east1"}



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/location/locations.rb', line 83

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#location_id ⇒ ::String

Returns The canonical id for this location. For example: "us-east1".

Returns:

  • (::String) —

    The canonical id for this location. For example: "us-east1".



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/location/locations.rb', line 83

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Any

Returns Service-specific metadata. For example the available capacity at the given location.

Returns:

  • (::Google::Protobuf::Any) —

    Service-specific metadata. For example the available capacity at the given location.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/location/locations.rb', line 83

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1".

Returns:

  • (::String) —

    Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/location/locations.rb', line 83

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end