- 4.50.0 (latest)
- 4.49.0
- 4.48.0
- 4.46.0
- 4.45.0
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public interface InstantiateWorkflowTemplateRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsParameters(String key)
public abstract boolean containsParameters(String key)Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getName()
public abstract String getName()Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getParameters()
public abstract Map<String,String> getParameters()Use #getParametersMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getParametersCount()
public abstract int getParametersCount()Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getParametersMap()
public abstract Map<String,String> getParametersMap()Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getParametersOrDefault(String key, String defaultValue)
public abstract String getParametersOrDefault(String key, String defaultValue)Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getParametersOrThrow(String key)
public abstract String getParametersOrThrow(String key)Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getRequestId()
public abstract String getRequestId()Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.
It is recommended to always set this value to a UUID.
The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The requestId. |
getRequestIdBytes()
public abstract ByteString getRequestIdBytes()Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.
It is recommended to always set this value to a UUID.
The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for requestId. |
getVersion()
public abstract int getVersion()Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.
This option cannot be used to instantiate a previous version of workflow template.
int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The version. |