Reference documentation and code samples for the Google API Common Protos Client class Publishing.
This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
Generated from protobuf message google.api.Publishing
Namespace
Google \ ApiMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ method_settings |
array<Google\Api\MethodSettings>
A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern. |
↳ 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 |
↳ documentation_uri |
string
Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview |
↳ 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". |
↳ github_label |
string
GitHub label to apply to issues and pull requests opened for this API. |
↳ codeowner_github_teams |
array
GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API. |
↳ doc_tag_prefix |
string
A prefix used in sample code when demarking regions to be included in documentation. |
↳ organization |
int
For whom the client library is being published. |
↳ library_settings |
array<Google\Api\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. |
↳ proto_reference_documentation_uri |
string
Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc |
↳ rest_reference_documentation_uri |
string
Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest |
getMethodSettings
A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMethodSettings
A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Api\MethodSettings>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNewIssueUri
Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
| Returns | |
|---|---|
| Type | Description |
string |
|
setNewIssueUri
Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentationUri
Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
| Returns | |
|---|---|
| Type | Description |
string |
|
setDocumentationUri
Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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".
| Returns | |
|---|---|
| Type | Description |
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGithubLabel
GitHub label to apply to issues and pull requests opened for this API.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGithubLabel
GitHub label to apply to issues and pull requests opened for this API.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCodeownerGithubTeams
GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCodeownerGithubTeams
GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocTagPrefix
A prefix used in sample code when demarking regions to be included in documentation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDocTagPrefix
A prefix used in sample code when demarking regions to be included in documentation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrganization
For whom the client library is being published.
| Returns | |
|---|---|
| Type | Description |
int |
|
setOrganization
For whom the client library is being published.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Api\ClientLibrarySettings>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProtoReferenceDocumentationUri
Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
| Returns | |
|---|---|
| Type | Description |
string |
|
setProtoReferenceDocumentationUri
Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRestReferenceDocumentationUri
Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest
| Returns | |
|---|---|
| Type | Description |
string |
|
setRestReferenceDocumentationUri
Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|