Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class TemplateMetadata.
Metadata describing a template.
Generated from protobuf message google.dataflow.v1beta3.TemplateMetadata
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the template. |
↳ description |
string
Optional. A description of the template. |
↳ parameters |
array<ParameterMetadata>
The parameters for the template. |
↳ streaming |
bool
Optional. Indicates if the template is streaming or not. |
↳ supports_at_least_once |
bool
Optional. Indicates if the streaming template supports at least once mode. |
↳ supports_exactly_once |
bool
Optional. Indicates if the streaming template supports exactly once mode. |
↳ default_streaming_mode |
string
Optional. Indicates the default streaming mode for a streaming template. Only valid if both supports_at_least_once and supports_exactly_once are true. Possible values: UNSPECIFIED, EXACTLY_ONCE and AT_LEAST_ONCE |
getName
Required. The name of the template.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the template.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the template.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A description of the template.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameters
The parameters for the template.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setParameters
The parameters for the template.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ParameterMetadata>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStreaming
Optional. Indicates if the template is streaming or not.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setStreaming
Optional. Indicates if the template is streaming or not.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupportsAtLeastOnce
Optional. Indicates if the streaming template supports at least once mode.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSupportsAtLeastOnce
Optional. Indicates if the streaming template supports at least once mode.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupportsExactlyOnce
Optional. Indicates if the streaming template supports exactly once mode.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSupportsExactlyOnce
Optional. Indicates if the streaming template supports exactly once mode.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultStreamingMode
Optional. Indicates the default streaming mode for a streaming template.
Only valid if both supports_at_least_once and supports_exactly_once are true. Possible values: UNSPECIFIED, EXACTLY_ONCE and AT_LEAST_ONCE
| Returns | |
|---|---|
| Type | Description |
string |
|
setDefaultStreamingMode
Optional. Indicates the default streaming mode for a streaming template.
Only valid if both supports_at_least_once and supports_exactly_once are true. Possible values: UNSPECIFIED, EXACTLY_ONCE and AT_LEAST_ONCE
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|