Documentation

Publishing extends Message
in package

Application

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

Generated from protobuf message google.api.Publishing

Properties

$api_short_name : mixed: Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
$doc_tag_prefix : mixed: A prefix used in sample code when demarking regions to be included in documentation.
$documentation_uri : mixed: Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
$github_label : mixed: GitHub label to apply to issues and pull requests opened for this API.
$new_issue_uri : mixed: Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
$organization : mixed: For whom the client library is being published.
$proto_reference_documentation_uri : mixed: Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
$codeowner_github_teams : mixed: GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
$library_settings : mixed: 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.
$method_settings : mixed: A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.

Methods

__construct() : mixed: Constructor.
getApiShortName() : 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".
getCodeownerGithubTeams() : RepeatedField: GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
getDocTagPrefix() : string: A prefix used in sample code when demarking regions to be included in documentation.
getDocumentationUri() : string: Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
getGithubLabel() : string: GitHub label to apply to issues and pull requests opened for this API.
getLibrarySettings() : RepeatedField: 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.
getMethodSettings() : RepeatedField: A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
getNewIssueUri() : string: Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
getOrganization() : int: For whom the client library is being published.
getProtoReferenceDocumentationUri() : string: Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
setApiShortName() : $this: Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
setCodeownerGithubTeams() : $this: GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
setDocTagPrefix() : $this: A prefix used in sample code when demarking regions to be included in documentation.
setDocumentationUri() : $this: Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
setGithubLabel() : $this: GitHub label to apply to issues and pull requests opened for this API.
setLibrarySettings() : $this: 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.
setMethodSettings() : $this: A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
setNewIssueUri() : $this: Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
setOrganization() : $this: For whom the client library is being published.
setProtoReferenceDocumentationUri() : $this: Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc

$api_short_name

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


    protected
        mixed
    $api_short_name
     = ''

Generated from protobuf field string api_short_name = 103 [json_name = "apiShortName"];

$doc_tag_prefix

A prefix used in sample code when demarking regions to be included in documentation.


    protected
        mixed
    $doc_tag_prefix
     = ''

Generated from protobuf field string doc_tag_prefix = 106 [json_name = "docTagPrefix"];

$documentation_uri

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview


    protected
        mixed
    $documentation_uri
     = ''

Generated from protobuf field string documentation_uri = 102 [json_name = "documentationUri"];

$github_label

GitHub label to apply to issues and pull requests opened for this API.


    protected
        mixed
    $github_label
     = ''

Generated from protobuf field string github_label = 104 [json_name = "githubLabel"];

$new_issue_uri

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


    protected
        mixed
    $new_issue_uri
     = ''

Generated from protobuf field string new_issue_uri = 101 [json_name = "newIssueUri"];

$organization

For whom the client library is being published.


    protected
        mixed
    $organization
     = 0

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107 [json_name = "organization"];

$proto_reference_documentation_uri

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc


    protected
        mixed
    $proto_reference_documentation_uri
     = ''

Generated from protobuf field string proto_reference_documentation_uri = 110 [json_name = "protoReferenceDocumentationUri"];

$codeowner_github_teams

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


    private
        mixed
    $codeowner_github_teams

Generated from protobuf field repeated string codeowner_github_teams = 105 [json_name = "codeownerGithubTeams"];

$library_settings

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.


    private
        mixed
    $library_settings

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109 [json_name = "librarySettings"];

$method_settings

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


    private
        mixed
    $method_settings

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2 [json_name = "methodSettings"];

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $data = NULL ]) : mixed

Parameters

$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type array<\Google\Api\MethodSettings>|\Google\Protobuf\Internal\RepeatedField $method_settings
      A list of API method settings, e.g. the behavior for methods that use the
      long-running operation pattern.
@type string $new_issue_uri
      Link to a *public* URI where users can report issues.  Example:
      https://issuetracker.google.com/issues/new?component=190865&template=1161103
@type string $documentation_uri
      Link to product home page.  Example:
      https://cloud.google.com/asset-inventory/docs/overview
@type string $api_short_name
      Used as a tracking tag when collecting data about the APIs developer
      relations artifacts like docs, packages delivered to package managers,
      etc.  Example: "speech".
@type string $github_label
      GitHub label to apply to issues and pull requests opened for this API.
@type array<string>|\Google\Protobuf\Internal\RepeatedField $codeowner_github_teams
      GitHub teams to be added to CODEOWNERS in the directory in GitHub
      containing source code for the client libraries for this API.
@type string $doc_tag_prefix
      A prefix used in sample code when demarking regions to be included in
      documentation.
@type int $organization
      For whom the client library is being published.
@type array<\Google\Api\ClientLibrarySettings>|\Google\Protobuf\Internal\RepeatedField $library_settings
      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.
@type string $proto_reference_documentation_uri
      Optional link to proto reference documentation.  Example:
      https://cloud.google.com/pubsub/lite/docs/reference/rpc

}

getApiShortName()

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


    public
                    getApiShortName() : string

Generated from protobuf field string api_short_name = 103 [json_name = "apiShortName"];

Return values

string

getCodeownerGithubTeams()

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


    public
                    getCodeownerGithubTeams() : RepeatedField

Generated from protobuf field repeated string codeowner_github_teams = 105 [json_name = "codeownerGithubTeams"];

Return values

RepeatedField

getDocTagPrefix()

A prefix used in sample code when demarking regions to be included in documentation.


    public
                    getDocTagPrefix() : string

Generated from protobuf field string doc_tag_prefix = 106 [json_name = "docTagPrefix"];

Return values

string

getDocumentationUri()

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview


    public
                    getDocumentationUri() : string

Generated from protobuf field string documentation_uri = 102 [json_name = "documentationUri"];

Return values

string

getGithubLabel()

GitHub label to apply to issues and pull requests opened for this API.


    public
                    getGithubLabel() : string

Generated from protobuf field string github_label = 104 [json_name = "githubLabel"];

Return values

string

getLibrarySettings()

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.


    public
                    getLibrarySettings() : RepeatedField

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109 [json_name = "librarySettings"];

Return values

RepeatedField

getMethodSettings()

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


    public
                    getMethodSettings() : RepeatedField

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2 [json_name = "methodSettings"];

Return values

RepeatedField

getNewIssueUri()

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


    public
                    getNewIssueUri() : string

Generated from protobuf field string new_issue_uri = 101 [json_name = "newIssueUri"];

Return values

string

getOrganization()

For whom the client library is being published.


    public
                    getOrganization() : int

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107 [json_name = "organization"];

Return values

int

getProtoReferenceDocumentationUri()

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc


    public
                    getProtoReferenceDocumentationUri() : string

Generated from protobuf field string proto_reference_documentation_uri = 110 [json_name = "protoReferenceDocumentationUri"];

Return values

string

setApiShortName()

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


    public
                    setApiShortName(string $var) : $this

Generated from protobuf field string api_short_name = 103 [json_name = "apiShortName"];

Parameters

$var : string

Return values

$this

setCodeownerGithubTeams()

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


    public
                    setCodeownerGithubTeams(array<string|int, string>|RepeatedField $var) : $this

Generated from protobuf field repeated string codeowner_github_teams = 105 [json_name = "codeownerGithubTeams"];

Parameters

$var : array<string|int, string>|RepeatedField

Return values

$this

setDocTagPrefix()

A prefix used in sample code when demarking regions to be included in documentation.


    public
                    setDocTagPrefix(string $var) : $this

Generated from protobuf field string doc_tag_prefix = 106 [json_name = "docTagPrefix"];

Parameters

$var : string

Return values

$this

setDocumentationUri()

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview


    public
                    setDocumentationUri(string $var) : $this

Generated from protobuf field string documentation_uri = 102 [json_name = "documentationUri"];

Parameters

$var : string

Return values

$this

setGithubLabel()

GitHub label to apply to issues and pull requests opened for this API.


    public
                    setGithubLabel(string $var) : $this

Generated from protobuf field string github_label = 104 [json_name = "githubLabel"];

Parameters

$var : string

Return values

$this

setLibrarySettings()

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.


    public
                    setLibrarySettings(array<string|int, ClientLibrarySettings>|RepeatedField $var) : $this

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109 [json_name = "librarySettings"];

Parameters

$var : array<string|int, ClientLibrarySettings>|RepeatedField

Return values

$this

setMethodSettings()

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


    public
                    setMethodSettings(array<string|int, MethodSettings>|RepeatedField $var) : $this

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2 [json_name = "methodSettings"];

Parameters

$var : array<string|int, MethodSettings>|RepeatedField

Return values

$this

setNewIssueUri()

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


    public
                    setNewIssueUri(string $var) : $this

Generated from protobuf field string new_issue_uri = 101 [json_name = "newIssueUri"];

Parameters

$var : string

Return values

$this

setOrganization()

For whom the client library is being published.


    public
                    setOrganization(int $var) : $this

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107 [json_name = "organization"];

Parameters

$var : int

Return values

$this

setProtoReferenceDocumentationUri()

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc


    public
                    setProtoReferenceDocumentationUri(string $var) : $this

Generated from protobuf field string proto_reference_documentation_uri = 110 [json_name = "protoReferenceDocumentationUri"];

Parameters

$var : string

Return values

$this

Publishing extends Message in package Application

Table of Contents

Properties

Methods

Properties

$api_short_name

$doc_tag_prefix

$documentation_uri

$github_label

$new_issue_uri

$organization

$proto_reference_documentation_uri

$codeowner_github_teams

$library_settings

$method_settings

Methods

__construct()

Parameters

getApiShortName()

Return values

getCodeownerGithubTeams()

Return values

getDocTagPrefix()

Return values

getDocumentationUri()

Return values

getGithubLabel()

Return values

getLibrarySettings()

Return values

getMethodSettings()

Return values

getNewIssueUri()

Return values

getOrganization()

Return values

getProtoReferenceDocumentationUri()

Return values

setApiShortName()

Parameters

Return values

setCodeownerGithubTeams()

Parameters

Return values

setDocTagPrefix()

Parameters

Return values

setDocumentationUri()

Parameters

Return values

setGithubLabel()

Parameters

Return values

setLibrarySettings()

Parameters

Return values

setMethodSettings()

Parameters

Return values

setNewIssueUri()

Parameters

Return values

setOrganization()

Parameters

Return values

setProtoReferenceDocumentationUri()

Parameters

Return values

Publishing extends Message
in package

Application