ClientLibrarySettings class

Details about how and where to publish client libraries.

Available extensions

Constructors

ClientLibrarySettings({String? version, LaunchStage? launchStage, bool? restNumericEnums, JavaSettings? javaSettings, CppSettings? cppSettings, PhpSettings? phpSettings, PythonSettings? pythonSettings, NodeSettings? nodeSettings, DotnetSettings? dotnetSettings, RubySettings? rubySettings, GoSettings? goSettings})
factory
ClientLibrarySettings.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
ClientLibrarySettings.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

cppSettings CppSettings
Settings for C++ client libraries.
getter/setter pair
dotnetSettings DotnetSettings
Settings for .NET client libraries.
getter/setter pair
goSettings GoSettings
Settings for Go client libraries.
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 true if this message is marked read-only. Otherwise false.
no setterinherited
javaSettings JavaSettings
Settings for legacy Java features, supported in the Service YAML.
getter/setter pair
launchStage LaunchStage
Launch stage of this version of the API.
getter/setter pair
nodeSettings NodeSettings
Settings for Node client libraries.
getter/setter pair
phpSettings PhpSettings
Settings for PHP client libraries.
getter/setter pair
pythonSettings PythonSettings
Settings for Python client libraries.
getter/setter pair
restNumericEnums bool
When using transport=rest, the client request will encode enums as numbers rather than strings.
getter/setter pair
rubySettings RubySettings
Settings for Ruby client libraries.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
unknownFields → UnknownFieldSet
no setterinherited
version String
Version of the API to apply these settings to.
getter/setter pair

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
clearCppSettings() → void
clearDotnetSettings() → 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
clearGoSettings() → void
clearJavaSettings() → void
clearLaunchStage() → void
clearNodeSettings() → void
clearPhpSettings() → void
clearPythonSettings() → void
clearRestNumericEnums() → void
clearRubySettings() → void
clearVersion() → void
clone() ClientLibrarySettings
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(ClientLibrarySettings)) ClientLibrarySettings
Apply updates to a copy of this message.
createEmptyInstance() ClientLibrarySettings
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.
ensureCppSettings() CppSettings
ensureDotnetSettings() DotnetSettings
ensureGoSettings() GoSettings
ensureJavaSettings() JavaSettings
ensureNodeSettings() NodeSettings
ensurePhpSettings() PhpSettings
ensurePythonSettings() PythonSettings
ensureRubySettings() RubySettings
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
hasCppSettings() bool
hasDotnetSettings() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasGoSettings() bool
hasJavaSettings() bool
hasLaunchStage() bool
hasNodeSettings() bool
hasPhpSettings() bool
hasPythonSettings() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasRestNumericEnums() bool
hasRubySettings() bool
hasVersion() bool
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 a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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 other into 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

Apply updates to 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 given CodedBufferWriter.
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