Instance class

Represents a Data Fusion instance.

Inheritance
  • Object
  • GeneratedMessage
  • Instance

Constructors

Instance({String? name, String? description, Instance_Type? type, bool? enableStackdriverLogging, bool? enableStackdriverMonitoring, bool? privateInstance, NetworkConfig? networkConfig, Map<String, String>? labels, Map<String, String>? options, Timestamp? createTime, Timestamp? updateTime, Instance_State? state, String? stateMessage, String? serviceEndpoint, String? zone, String? version, String? serviceAccount, String? displayName, Iterable<Version>? availableVersion, String? apiEndpoint, String? gcsBucket, Iterable<Accelerator>? accelerators, String? p4ServiceAccount, String? tenantProjectId, String? dataprocServiceAccount, bool? enableRbac, CryptoKeyConfig? cryptoKeyConfig, Iterable<Instance_DisabledReason>? disabledReason, EventPublishConfig? eventPublishConfig, bool? enableZoneSeparation})
factory
Instance.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
Instance.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

accelerators → List<Accelerator>
List of accelerators enabled for this CDF instance.
no setter
apiEndpoint ↔ String
Output only. Endpoint on which the REST APIs is accessible.
getter/setter pair
availableVersion → List<Version>
Available versions that the instance can be upgraded to using UpdateInstanceRequest.
no setter
createTime ↔ Timestamp
Output only. The time the instance was created.
getter/setter pair
cryptoKeyConfig ↔ CryptoKeyConfig
The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
getter/setter pair
dataprocServiceAccount ↔ String
User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
getter/setter pair
description ↔ String
A description of this instance.
getter/setter pair
disabledReason → List<Instance_DisabledReason>
Output only. If the instance state is DISABLED, the reason for disabling the instance.
no setter
displayName ↔ String
Display name for an instance.
getter/setter pair
enableRbac ↔ bool
Option to enable granular role-based access control.
getter/setter pair
enableStackdriverLogging ↔ bool
Option to enable Stackdriver Logging.
getter/setter pair
enableStackdriverMonitoring ↔ bool
Option to enable Stackdriver Monitoring.
getter/setter pair
enableZoneSeparation ↔ bool
Option to enable granular zone separation.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
eventPublishConfig ↔ EventPublishConfig
Option to enable and pass metadata for event publishing.
getter/setter pair
gcsBucket ↔ String
Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
labels → Map<String, String>
The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.
no setter
name ↔ String
Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
getter/setter pair
networkConfig ↔ NetworkConfig
Network configuration options. These are required when a private Data Fusion instance is to be created.
getter/setter pair
options → Map<String, String>
Map of additional options used to configure the behavior of Data Fusion instance.
no setter
p4ServiceAccount ↔ String
Output only. P4 service account for the customer project.
getter/setter pair
privateInstance ↔ bool
Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccount ↔ String
Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
getter/setter pair
serviceEndpoint ↔ String
Output only. Endpoint on which the Data Fusion UI is accessible.
getter/setter pair
state ↔ Instance_State
Output only. The current state of this Data Fusion instance.
getter/setter pair
stateMessage ↔ String
Output only. Additional information about the current state of this Data Fusion instance if available.
getter/setter pair
tenantProjectId ↔ String
Output only. The name of the tenant project.
getter/setter pair
type ↔ Instance_Type
Required. Instance type.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
updateTime ↔ Timestamp
Output only. The time the instance was last updated.
getter/setter pair
version ↔ String
Current version of the Data Fusion. Only specifiable in Update.
getter/setter pair
zone ↔ String
Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
getter/setter pair

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
clearApiEndpoint() → void
clearCreateTime() → void
clearCryptoKeyConfig() → void
clearDataprocServiceAccount() → void
clearDescription() → void
clearDisplayName() → void
clearEnableRbac() → void
clearEnableStackdriverLogging() → void
clearEnableStackdriverMonitoring() → void
clearEnableZoneSeparation() → void
clearEventPublishConfig() → 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
clearGcsBucket() → void
clearName() → void
clearNetworkConfig() → void
clearP4ServiceAccount() → void
clearPrivateInstance() → void
clearServiceAccount() → void
clearServiceEndpoint() → void
clearState() → void
clearStateMessage() → void
clearTenantProjectId() → void
clearType() → void
clearUpdateTime() → void
clearVersion() → void
clearZone() → void
clone() → Instance
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(Instance)) → Instance
Apply updates to a copy of this message.
override
createEmptyInstance() → Instance
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
ensureCryptoKeyConfig() → CryptoKeyConfig
ensureEventPublishConfig() → EventPublishConfig
ensureNetworkConfig() → NetworkConfig
ensureUpdateTime() → 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
hasApiEndpoint() → bool
hasCreateTime() → bool
hasCryptoKeyConfig() → bool
hasDataprocServiceAccount() → bool
hasDescription() → bool
hasDisplayName() → bool
hasEnableRbac() → bool
hasEnableStackdriverLogging() → bool
hasEnableStackdriverMonitoring() → bool
hasEnableZoneSeparation() → bool
hasEventPublishConfig() → 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
hasGcsBucket() → bool
hasName() → bool
hasNetworkConfig() → bool
hasP4ServiceAccount() → bool
hasPrivateInstance() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasServiceAccount() → bool
hasServiceEndpoint() → bool
hasState() → bool
hasStateMessage() → bool
hasTenantProjectId() → bool
hasType() → bool
hasUpdateTime() → bool
hasVersion() → bool
hasZone() → 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() → Instance
createRepeated() → PbList<Instance>
getDefault() → Instance