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.



3976
3977
3978
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3976

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) 


3915
3916
3917
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3915

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>) 


3921
3922
3923
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3921

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) 


3927
3928
3929
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3927

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) 


3933
3934
3935
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3933

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) 


3938
3939
3940
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3938

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:



3945
3946
3947
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3945

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:



3951
3952
3953
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3951

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) 


3957
3958
3959
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3957

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) 


3962
3963
3964
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3962

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) 


3968
3969
3970
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3968

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) 


3974
3975
3976
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3974

def rest_reference_documentation_uri
  @rest_reference_documentation_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3981

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