Class: Gapic::Model::ApiMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/gapic/model/api_metadata.rb

Overview

A collection of metadata about an API.

This information generally comes from the service yaml rather than from proto input.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_populated_fields_by_method_name ⇒ Hash{String => Array<String>} (readonly)

Returns A mapping from method name to a list of auto populated fields.

Returns:

  • (Hash{String => Array<String>}) —

    A mapping from method name to a list of auto populated fields.



77
78
79
 
# File 'lib/gapic/model/api_metadata.rb', line 77

def auto_populated_fields_by_method_name
  @auto_populated_fields_by_method_name
end

#description ⇒ String (readonly)

Returns A longer description of the API, suitable for the RubyGems description field.

Returns:

  • (String) —

    A longer description of the API, suitable for the RubyGems description field.



54
55
56
 
# File 'lib/gapic/model/api_metadata.rb', line 54

def description
  @description
end

#doc_tag_prefix ⇒ String (readonly)

Returns The prefix string for sample doc tags.

Returns:

  • (String) —

    The prefix string for sample doc tags.



71
72
73
 
# File 'lib/gapic/model/api_metadata.rb', line 71

def doc_tag_prefix
  @doc_tag_prefix
end

#documentation_url ⇒ String (readonly)

Returns The URL for the documentation.

Returns:

  • (String) —

    The URL for the documentation.



66
67
68
 
# File 'lib/gapic/model/api_metadata.rb', line 66

def documentation_url
  @documentation_url
end

#name ⇒ String (readonly)

Returns The full ID of the API, including ".googleapis.com". For example, "pubsub.googleapis.com".

Returns:

  • (String) —

    The full ID of the API, including ".googleapis.com". For example, "pubsub.googleapis.com".



30
31
32
 
# File 'lib/gapic/model/api_metadata.rb', line 30

def name
  @name
end

#organization ⇒ String (readonly)

Returns The organization name, determining where the API's documentation should be published, among other things. This value is "CLOUD" for Google Cloud APIs.

Returns:

  • (String) —

    The organization name, determining where the API's documentation should be published, among other things. This value is "CLOUD" for Google Cloud APIs.



61
62
63
 
# File 'lib/gapic/model/api_metadata.rb', line 61

def organization
  @organization
end

#short_name ⇒ String (readonly)

Returns The shortname of the API, omitting ".googleapis.com". For example, "pubsub".

Returns:

  • (String) —

    The shortname of the API, omitting ".googleapis.com". For example, "pubsub".



36
37
38
 
# File 'lib/gapic/model/api_metadata.rb', line 36

def short_name
  @short_name
end

#summary ⇒ String (readonly)

Returns A short description of the API, suitable for the RubyGems summary field.

Returns:

  • (String) —

    A short description of the API, suitable for the RubyGems summary field.



48
49
50
 
# File 'lib/gapic/model/api_metadata.rb', line 48

def summary
  @summary
end

#title ⇒ String (readonly)

Returns A title of the API, including the version. For example, "Cloud Pub/Sub V1".

Returns:

  • (String) —

    A title of the API, including the version. For example, "Cloud Pub/Sub V1"



42
43
44
 
# File 'lib/gapic/model/api_metadata.rb', line 42

def title
  @title
end