ApiDeployment class

Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

Inheritance
  • Object
  • GeneratedMessage
  • ApiDeployment

Constructors

ApiDeployment({String? name, String? displayName, String? description, String? revisionId, Timestamp? createTime, Timestamp? revisionCreateTime, Timestamp? revisionUpdateTime, String? apiSpecRevision, String? endpointUri, String? externalChannelUri, String? intendedAudience, String? accessGuidance, Map<String, String>? labels, Map<String, String>? annotations})
factory
ApiDeployment.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
ApiDeployment.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

accessGuidance String
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
getter/setter pair
annotations Map<String, String>
Annotations attach non-identifying metadata to resources.
no setter
apiSpecRevision String
The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}
getter/setter pair
createTime Timestamp
Output only. Creation timestamp; when the deployment resource was created.
getter/setter pair
description String
A detailed description.
getter/setter pair
displayName String
Human-meaningful name.
getter/setter pair
endpointUri String
The address where the deployment is serving. Changes to this value will update the revision.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
externalChannelUri String
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
intendedAudience String
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
getter/setter pair
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
labels Map<String, String>
Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.
no setter
name String
Resource name.
getter/setter pair
revisionCreateTime Timestamp
Output only. Revision creation timestamp; when the represented revision was created.
getter/setter pair
revisionId String
Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
getter/setter pair
revisionUpdateTime Timestamp
Output only. Last update timestamp: when the represented revision was last modified.
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
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAccessGuidance() → void
clearApiSpecRevision() → void
clearCreateTime() → void
clearDescription() → void
clearDisplayName() → void
clearEndpointUri() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearExternalChannelUri() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearIntendedAudience() → void
clearName() → void
clearRevisionCreateTime() → void
clearRevisionId() → void
clearRevisionUpdateTime() → void
clone() ApiDeployment
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(ApiDeployment)) ApiDeployment
Apply updates to a copy of this message.
override
createEmptyInstance() ApiDeployment
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) List<T>
Creates List implementing a mutable repeated field.
inherited
ensureCreateTime() Timestamp
ensureRevisionCreateTime() Timestamp
ensureRevisionUpdateTime() Timestamp
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
hasAccessGuidance() bool
hasApiSpecRevision() bool
hasCreateTime() bool
hasDescription() bool
hasDisplayName() bool
hasEndpointUri() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasExternalChannelUri() bool
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasIntendedAudience() bool
hasName() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasRevisionCreateTime() bool
hasRevisionId() bool
hasRevisionUpdateTime() 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
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
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
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
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() ApiDeployment
createRepeated() → PbList<ApiDeployment>
getDefault() ApiDeployment