Class Publishing (2.42.0)

public final class Publishing extends GeneratedMessageV3 implements PublishingOrBuilder

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

Protobuf type google.api.Publishing

Implements

PublishingOrBuilder

Static Fields

API_SHORT_NAME_FIELD_NUMBER

public static final int API_SHORT_NAME_FIELD_NUMBER
Field Value
Type Description
int

CODEOWNER_GITHUB_TEAMS_FIELD_NUMBER

public static final int CODEOWNER_GITHUB_TEAMS_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENTATION_URI_FIELD_NUMBER

public static final int DOCUMENTATION_URI_FIELD_NUMBER
Field Value
Type Description
int

DOC_TAG_PREFIX_FIELD_NUMBER

public static final int DOC_TAG_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

GITHUB_LABEL_FIELD_NUMBER

public static final int GITHUB_LABEL_FIELD_NUMBER
Field Value
Type Description
int

LIBRARY_SETTINGS_FIELD_NUMBER

public static final int LIBRARY_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

METHOD_SETTINGS_FIELD_NUMBER

public static final int METHOD_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

NEW_ISSUE_URI_FIELD_NUMBER

public static final int NEW_ISSUE_URI_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_FIELD_NUMBER

public static final int ORGANIZATION_FIELD_NUMBER
Field Value
Type Description
int

PROTO_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER

public static final int PROTO_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER
Field Value
Type Description
int

REST_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER

public static final int REST_REFERENCE_DOCUMENTATION_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Publishing getDefaultInstance()
Returns
Type Description
Publishing

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Publishing.Builder newBuilder()
Returns
Type Description
Publishing.Builder

newBuilder(Publishing prototype)

public static Publishing.Builder newBuilder(Publishing prototype)
Parameter
Name Description
prototype Publishing
Returns
Type Description
Publishing.Builder

parseDelimitedFrom(InputStream input)

public static Publishing parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Publishing parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Publishing parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Publishing parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Publishing parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Publishing parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Publishing parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Publishing parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Publishing parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Publishing parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Publishing parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Publishing parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Publishing
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Publishing> parser()
Returns
Type Description
Parser<Publishing>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiShortName()

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

string api_short_name = 103;

Returns
Type Description
String

The apiShortName.

getApiShortNameBytes()

public ByteString getApiShortNameBytes()

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

string api_short_name = 103;

Returns
Type Description
ByteString

The bytes for apiShortName.

getCodeownerGithubTeams(int index)

public String getCodeownerGithubTeams(int index)

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

repeated string codeowner_github_teams = 105;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The codeownerGithubTeams at the given index.

getCodeownerGithubTeamsBytes(int index)

public ByteString getCodeownerGithubTeamsBytes(int index)

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

repeated string codeowner_github_teams = 105;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the codeownerGithubTeams at the given index.

getCodeownerGithubTeamsCount()

public int getCodeownerGithubTeamsCount()

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

repeated string codeowner_github_teams = 105;

Returns
Type Description
int

The count of codeownerGithubTeams.

getCodeownerGithubTeamsList()

public ProtocolStringList getCodeownerGithubTeamsList()

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

repeated string codeowner_github_teams = 105;

Returns
Type Description
ProtocolStringList

A list containing the codeownerGithubTeams.

getDefaultInstanceForType()

public Publishing getDefaultInstanceForType()
Returns
Type Description
Publishing

getDocTagPrefix()

public String getDocTagPrefix()

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

string doc_tag_prefix = 106;

Returns
Type Description
String

The docTagPrefix.

getDocTagPrefixBytes()

public ByteString getDocTagPrefixBytes()

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

string doc_tag_prefix = 106;

Returns
Type Description
ByteString

The bytes for docTagPrefix.

getDocumentationUri()

public String getDocumentationUri()

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

string documentation_uri = 102;

Returns
Type Description
String

The documentationUri.

getDocumentationUriBytes()

public ByteString getDocumentationUriBytes()

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

string documentation_uri = 102;

Returns
Type Description
ByteString

The bytes for documentationUri.

getGithubLabel()

public String getGithubLabel()

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

string github_label = 104;

Returns
Type Description
String

The githubLabel.

getGithubLabelBytes()

public ByteString getGithubLabelBytes()

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

string github_label = 104;

Returns
Type Description
ByteString

The bytes for githubLabel.

getLibrarySettings(int index)

public ClientLibrarySettings getLibrarySettings(int index)

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.

repeated .google.api.ClientLibrarySettings library_settings = 109;

Parameter
Name Description
index int
Returns
Type Description
ClientLibrarySettings

getLibrarySettingsCount()

public int getLibrarySettingsCount()

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.

repeated .google.api.ClientLibrarySettings library_settings = 109;

Returns
Type Description
int

getLibrarySettingsList()

public List<ClientLibrarySettings> getLibrarySettingsList()

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.

repeated .google.api.ClientLibrarySettings library_settings = 109;

Returns
Type Description
List<ClientLibrarySettings>

getLibrarySettingsOrBuilder(int index)

public ClientLibrarySettingsOrBuilder getLibrarySettingsOrBuilder(int index)

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.

repeated .google.api.ClientLibrarySettings library_settings = 109;

Parameter
Name Description
index int
Returns
Type Description
ClientLibrarySettingsOrBuilder

getLibrarySettingsOrBuilderList()

public List<? extends ClientLibrarySettingsOrBuilder> getLibrarySettingsOrBuilderList()

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.

repeated .google.api.ClientLibrarySettings library_settings = 109;

Returns
Type Description
List<? extends com.google.api.ClientLibrarySettingsOrBuilder>

getMethodSettings(int index)

public MethodSettings getMethodSettings(int index)

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

repeated .google.api.MethodSettings method_settings = 2;

Parameter
Name Description
index int
Returns
Type Description
MethodSettings

getMethodSettingsCount()

public int getMethodSettingsCount()

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

repeated .google.api.MethodSettings method_settings = 2;

Returns
Type Description
int

getMethodSettingsList()

public List<MethodSettings> getMethodSettingsList()

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

repeated .google.api.MethodSettings method_settings = 2;

Returns
Type Description
List<MethodSettings>

getMethodSettingsOrBuilder(int index)

public MethodSettingsOrBuilder getMethodSettingsOrBuilder(int index)

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

repeated .google.api.MethodSettings method_settings = 2;

Parameter
Name Description
index int
Returns
Type Description
MethodSettingsOrBuilder

getMethodSettingsOrBuilderList()

public List<? extends MethodSettingsOrBuilder> getMethodSettingsOrBuilderList()

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

repeated .google.api.MethodSettings method_settings = 2;

Returns
Type Description
List<? extends com.google.api.MethodSettingsOrBuilder>

getNewIssueUri()

public String getNewIssueUri()

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

string new_issue_uri = 101;

Returns
Type Description
String

The newIssueUri.

getNewIssueUriBytes()

public ByteString getNewIssueUriBytes()

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

string new_issue_uri = 101;

Returns
Type Description
ByteString

The bytes for newIssueUri.

getOrganization()

public ClientLibraryOrganization getOrganization()

For whom the client library is being published.

.google.api.ClientLibraryOrganization organization = 107;

Returns
Type Description
ClientLibraryOrganization

The organization.

getOrganizationValue()

public int getOrganizationValue()

For whom the client library is being published.

.google.api.ClientLibraryOrganization organization = 107;

Returns
Type Description
int

The enum numeric value on the wire for organization.

getParserForType()

public Parser<Publishing> getParserForType()
Returns
Type Description
Parser<Publishing>
Overrides

getProtoReferenceDocumentationUri()

public String getProtoReferenceDocumentationUri()

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

string proto_reference_documentation_uri = 110;

Returns
Type Description
String

The protoReferenceDocumentationUri.

getProtoReferenceDocumentationUriBytes()

public ByteString getProtoReferenceDocumentationUriBytes()

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

string proto_reference_documentation_uri = 110;

Returns
Type Description
ByteString

The bytes for protoReferenceDocumentationUri.

getRestReferenceDocumentationUri()

public String getRestReferenceDocumentationUri()

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

string rest_reference_documentation_uri = 111;

Returns
Type Description
String

The restReferenceDocumentationUri.

getRestReferenceDocumentationUriBytes()

public ByteString getRestReferenceDocumentationUriBytes()

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

string rest_reference_documentation_uri = 111;

Returns
Type Description
ByteString

The bytes for restReferenceDocumentationUri.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Publishing.Builder newBuilderForType()
Returns
Type Description
Publishing.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Publishing.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Publishing.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Publishing.Builder toBuilder()
Returns
Type Description
Publishing.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException