Class: Google::Apis::ServiceusageV1::Publishing

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb

Overview

This message configures the settings for publishing Google Cloud Client libraries generated from the service config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Publishing

Returns a new instance of Publishing.



4998
4999
5000
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4998

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_short_name ⇒ String

Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: " speech". Corresponds to the JSON property apiShortName

Returns:

  • (String) 


4937
4938
4939
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4937

def api_short_name
  @api_short_name
end

#codeowner_github_teams ⇒ Array<String>

GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API. Corresponds to the JSON property codeownerGithubTeams

Returns:

  • (Array<String>) 


4943
4944
4945
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4943

def codeowner_github_teams
  @codeowner_github_teams
end

#doc_tag_prefix ⇒ String

A prefix used in sample code when demarking regions to be included in documentation. Corresponds to the JSON property docTagPrefix

Returns:

  • (String) 


4949
4950
4951
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4949

def doc_tag_prefix
  @doc_tag_prefix
end

#documentation_uri ⇒ String

Link to product home page. Example: https://cloud.google.com/asset-inventory/ docs/overview Corresponds to the JSON property documentationUri

Returns:

  • (String) 


4955
4956
4957
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4955

def documentation_uri
  @documentation_uri
end

#github_label ⇒ String

GitHub label to apply to issues and pull requests opened for this API. Corresponds to the JSON property githubLabel

Returns:

  • (String) 


4960
4961
4962
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4960

def github_label
  @github_label
end

#library_settings ⇒ Array<Google::Apis::ServiceusageV1::ClientLibrarySettings>

Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded. Corresponds to the JSON property librarySettings

Returns:



4967
4968
4969
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4967

def library_settings
  @library_settings
end

#method_settings ⇒ Array<Google::Apis::ServiceusageV1::MethodSettings>

A list of API method settings, e.g. the behavior for methods that use the long- running operation pattern. Corresponds to the JSON property methodSettings

Returns:



4973
4974
4975
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4973

def method_settings
  @method_settings
end

#new_issue_uri ⇒ String

Link to a public URI where users can report issues. Example: https:// issuetracker.google.com/issues/new?component=190865&template=1161103 Corresponds to the JSON property newIssueUri

Returns:

  • (String) 


4979
4980
4981
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4979

def new_issue_uri
  @new_issue_uri
end

#organization ⇒ String

For whom the client library is being published. Corresponds to the JSON property organization

Returns:

  • (String) 


4984
4985
4986
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4984

def organization
  @organization
end

#proto_reference_documentation_uri ⇒ String

Optional link to proto reference documentation. Example: https://cloud.google. com/pubsub/lite/docs/reference/rpc Corresponds to the JSON property protoReferenceDocumentationUri

Returns:

  • (String) 


4990
4991
4992
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4990

def proto_reference_documentation_uri
  @proto_reference_documentation_uri
end

#rest_reference_documentation_uri ⇒ String

Optional link to REST reference documentation. Example: https://cloud.google. com/pubsub/lite/docs/reference/rest Corresponds to the JSON property restReferenceDocumentationUri

Returns:

  • (String) 


4996
4997
4998
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 4996

def rest_reference_documentation_uri
  @rest_reference_documentation_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5003

def update!(**args)
  @api_short_name = args[:api_short_name] if args.key?(:api_short_name)
  @codeowner_github_teams = args[:codeowner_github_teams] if args.key?(:codeowner_github_teams)
  @doc_tag_prefix = args[:doc_tag_prefix] if args.key?(:doc_tag_prefix)
  @documentation_uri = args[:documentation_uri] if args.key?(:documentation_uri)
  @github_label = args[:github_label] if args.key?(:github_label)
  @library_settings = args[:library_settings] if args.key?(:library_settings)
  @method_settings = args[:method_settings] if args.key?(:method_settings)
  @new_issue_uri = args[:new_issue_uri] if args.key?(:new_issue_uri)
  @organization = args[:organization] if args.key?(:organization)
  @proto_reference_documentation_uri = args[:proto_reference_documentation_uri] if args.key?(:proto_reference_documentation_uri)
  @rest_reference_documentation_uri = args[:rest_reference_documentation_uri] if args.key?(:rest_reference_documentation_uri)
end