Represents an Environment.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IEnvironment);
Constructs a new Environment.
Parameter | |
---|---|
Name | Description |
properties |
IEnvironment
Properties to set |
Properties
clusterManagerApiService
public clusterManagerApiService: string;
Environment clusterManagerApiService.
dataset
public dataset: string;
Environment dataset.
debugOptions
public debugOptions?: (google.dataflow.v1beta3.IDebugOptions|null);
Environment debugOptions.
experiments
public experiments: string[];
Environment experiments.
flexResourceSchedulingGoal
public flexResourceSchedulingGoal: (google.dataflow.v1beta3.FlexResourceSchedulingGoal|keyof typeof google.dataflow.v1beta3.FlexResourceSchedulingGoal);
Environment flexResourceSchedulingGoal.
internalExperiments
public internalExperiments?: (google.protobuf.IAny|null);
Environment internalExperiments.
sdkPipelineOptions
public sdkPipelineOptions?: (google.protobuf.IStruct|null);
Environment sdkPipelineOptions.
serviceAccountEmail
public serviceAccountEmail: string;
Environment serviceAccountEmail.
serviceKmsKeyName
public serviceKmsKeyName: string;
Environment serviceKmsKeyName.
serviceOptions
public serviceOptions: string[];
Environment serviceOptions.
shuffleMode
public shuffleMode: (google.dataflow.v1beta3.ShuffleMode|keyof typeof google.dataflow.v1beta3.ShuffleMode);
Environment shuffleMode.
tempStoragePrefix
public tempStoragePrefix: string;
Environment tempStoragePrefix.
userAgent
public userAgent?: (google.protobuf.IStruct|null);
Environment userAgent.
version
public version?: (google.protobuf.IStruct|null);
Environment version.
workerPools
public workerPools: google.dataflow.v1beta3.IWorkerPool[];
Environment workerPools.
workerRegion
public workerRegion: string;
Environment workerRegion.
workerZone
public workerZone: string;
Environment workerZone.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IEnvironment): google.dataflow.v1beta3.Environment;
Creates a new Environment instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IEnvironment
Properties to set |
Returns | |
---|---|
Type | Description |
Environment | Environment instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.Environment;
Decodes an Environment message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Environment | Environment |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.Environment;
Decodes an Environment message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Environment | Environment |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Environment message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IEnvironment
Environment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.dataflow.v1beta3.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Environment message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IEnvironment
Environment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.dataflow.v1beta3.Environment;
Creates an Environment message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
Environment | Environment |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Environment
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Environment to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.Environment, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Environment message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Environment
Environment |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an Environment message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|