Publishing class
This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
- Available extensions
Constructors
-
Publishing({Iterable<
MethodSettings> ? methodSettings, String? newIssueUri, String? documentationUri, String? apiShortName, String? githubLabel, Iterable<String> ? codeownerGithubTeams, String? docTagPrefix, ClientLibraryOrganization? organization, Iterable<ClientLibrarySettings> ? librarySettings}) -
factory
-
Publishing.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- Publishing.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- apiShortName ↔ 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".
getter/setter pair
-
codeownerGithubTeams
→ PbList<
String> -
GitHub teams to be added to CODEOWNERS in the directory in GitHub
containing source code for the client libraries for this API.
no setter
- docTagPrefix ↔ String
-
A prefix used in sample code when demarking regions to be included in
documentation.
getter/setter pair
- documentationUri ↔ String
-
Link to product home page. Example:
https://cloud.google.com/asset-inventory/docs/overview
getter/setter pair
- githubLabel ↔ String
-
GitHub label to apply to issues and pull requests opened for this API.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited -
librarySettings
→ PbList<
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.
no setter
-
methodSettings
→ PbList<
MethodSettings> -
A list of API method settings, e.g. the behavior for methods that use the
long-running operation pattern.
no setter
- newIssueUri ↔ String
-
Link to a place that API users can report issues. Example:
https://issuetracker.google.com/issues/new?component=190865&template=1161103
getter/setter pair
- organization ↔ ClientLibraryOrganization
-
For whom the client library is being published.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearApiShortName(
) → void -
clearDocTagPrefix(
) → void -
clearDocumentationUri(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearGithubLabel(
) → void -
clearNewIssueUri(
) → void -
clearOrganization(
) → void -
clone(
) → Publishing - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(Publishing)) → Publishing -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → Publishing - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasApiShortName(
) → bool -
hasDocTagPrefix(
) → bool -
hasDocumentationUri(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasGithubLabel(
) → bool -
hasNewIssueUri(
) → bool -
hasOrganization(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Publishing -
createRepeated(
) → PbList< Publishing> -
getDefault(
) → Publishing