PHPFUI/InstaDoc

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

Generated from protobuf message google.api.Publishing

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type \Google\Api\MethodSettings[] $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 string[] $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 \Google\Api\ClientLibrarySettings[] $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
@type string $rest_reference_documentation_uri
      Optional link to REST reference documentation.  Example:
      https://cloud.google.com/pubsub/lite/docs/reference/rest

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public 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".

Generated from protobuf field string api_short_name = 103;

return string

public getCodeownerGithubTeams()

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

Generated from protobuf field repeated string codeowner_github_teams = 105;

return \RepeatedField<string>

public getDocTagPrefix()

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

Generated from protobuf field string doc_tag_prefix = 106;

return string

public getDocumentationUri()

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

Generated from protobuf field string documentation_uri = 102;

return string

public getGithubLabel()

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

Generated from protobuf field string github_label = 104;

return string

public 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.

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109;

return \RepeatedField<\Google\Api\ClientLibrarySettings>

public getMethodSettings()

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

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2;

return \RepeatedField<\Google\Api\MethodSettings>

public getNewIssueUri()

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

Generated from protobuf field string new_issue_uri = 101;

return string

public getOrganization()

For whom the client library is being published.

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107;

return int

public getProtoReferenceDocumentationUri()

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

Generated from protobuf field string proto_reference_documentation_uri = 110;

return string

public getRestReferenceDocumentationUri()

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

Generated from protobuf field string rest_reference_documentation_uri = 111;

return string

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setApiShortName( $var)

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

Generated from protobuf field string api_short_name = 103;

param string $var
return $this

public setCodeownerGithubTeams( $var)

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

Generated from protobuf field repeated string codeowner_github_teams = 105;

param string[] $var
return $this

public setDocTagPrefix( $var)

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

Generated from protobuf field string doc_tag_prefix = 106;

param string $var
return $this

public setDocumentationUri( $var)

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

Generated from protobuf field string documentation_uri = 102;

param string $var
return $this

public setGithubLabel( $var)

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

Generated from protobuf field string github_label = 104;

param string $var
return $this

public setLibrarySettings( $var)

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.

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109;

param \Google\Api\ClientLibrarySettings[] $var
return $this

public setMethodSettings( $var)

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

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2;

param \Google\Api\MethodSettings[] $var
return $this

public setNewIssueUri( $var)

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

Generated from protobuf field string new_issue_uri = 101;

param string $var
return $this

public setOrganization( $var)

For whom the client library is being published.

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107;

param int $var
return $this

public setProtoReferenceDocumentationUri( $var)

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

Generated from protobuf field string proto_reference_documentation_uri = 110;

param string $var
return $this

public setRestReferenceDocumentationUri( $var)

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

Generated from protobuf field string rest_reference_documentation_uri = 111;

param string $var
return $this

Properties

protected $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".

Generated from protobuf field string api_short_name = 103;

protected $doc_tag_prefix = ''

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

Generated from protobuf field string doc_tag_prefix = 106;

protected $documentation_uri = ''

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

Generated from protobuf field string documentation_uri = 102;

protected $github_label = ''

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

Generated from protobuf field string github_label = 104;

protected $new_issue_uri = ''

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

Generated from protobuf field string new_issue_uri = 101;

protected $organization = 0

For whom the client library is being published.

Generated from protobuf field .google.api.ClientLibraryOrganization organization = 107;

protected $proto_reference_documentation_uri = ''

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

Generated from protobuf field string proto_reference_documentation_uri = 110;

protected $rest_reference_documentation_uri = ''

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

Generated from protobuf field string rest_reference_documentation_uri = 111;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $codeowner_github_teams = NULL

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

Generated from protobuf field repeated string codeowner_github_teams = 105;

private $library_settings = NULL

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.

Generated from protobuf field repeated .google.api.ClientLibrarySettings library_settings = 109;

private $method_settings = NULL

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

Generated from protobuf field repeated .google.api.MethodSettings method_settings = 2;