Class PipelineJob
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1beta1.PipelineJob
-
- All Implemented Interfaces:
PipelineJobOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class PipelineJob extends com.google.protobuf.GeneratedMessageV3 implements PipelineJobOrBuilder
An instance of a machine learning PipelineJob.
Protobuf typegoogle.cloud.aiplatform.v1beta1.PipelineJob- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPipelineJob.BuilderAn instance of a machine learning PipelineJob.static classPipelineJob.RuntimeConfigThe runtime config of a PipelineJob.static interfacePipelineJob.RuntimeConfigOrBuilder-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intCREATE_TIME_FIELD_NUMBERstatic intDISPLAY_NAME_FIELD_NUMBERstatic intENCRYPTION_SPEC_FIELD_NUMBERstatic intEND_TIME_FIELD_NUMBERstatic intERROR_FIELD_NUMBERstatic intJOB_DETAIL_FIELD_NUMBERstatic intLABELS_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intNETWORK_FIELD_NUMBERstatic intPIPELINE_SPEC_FIELD_NUMBERstatic intRESERVED_IP_RANGES_FIELD_NUMBERstatic intRUNTIME_CONFIG_FIELD_NUMBERstatic intSCHEDULE_NAME_FIELD_NUMBERstatic intSERVICE_ACCOUNT_FIELD_NUMBERstatic intSTART_TIME_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intTEMPLATE_METADATA_FIELD_NUMBERstatic intTEMPLATE_URI_FIELD_NUMBERstatic intUPDATE_TIME_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)The labels with user-defined metadata to organize PipelineJob.booleanequals(Object obj)com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.static PipelineJobgetDefaultInstance()PipelineJobgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringgetDisplayName()The display name of the Pipeline.com.google.protobuf.ByteStringgetDisplayNameBytes()The display name of the Pipeline.EncryptionSpecgetEncryptionSpec()Customer-managed encryption key spec for a pipelineJob.EncryptionSpecOrBuildergetEncryptionSpecOrBuilder()Customer-managed encryption key spec for a pipelineJob.com.google.protobuf.TimestampgetEndTime()Output only.com.google.protobuf.TimestampOrBuildergetEndTimeOrBuilder()Output only.com.google.rpc.StatusgetError()Output only.com.google.rpc.StatusOrBuildergetErrorOrBuilder()Output only.PipelineJobDetailgetJobDetail()Output only.PipelineJobDetailOrBuildergetJobDetailOrBuilder()Output only.Map<String,String>getLabels()Deprecated.intgetLabelsCount()The labels with user-defined metadata to organize PipelineJob.Map<String,String>getLabelsMap()The labels with user-defined metadata to organize PipelineJob.StringgetLabelsOrDefault(String key, String defaultValue)The labels with user-defined metadata to organize PipelineJob.StringgetLabelsOrThrow(String key)The labels with user-defined metadata to organize PipelineJob.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.StringgetNetwork()The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered.com.google.protobuf.ByteStringgetNetworkBytes()The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered.com.google.protobuf.Parser<PipelineJob>getParserForType()com.google.protobuf.StructgetPipelineSpec()The spec of the pipeline.com.google.protobuf.StructOrBuildergetPipelineSpecOrBuilder()The spec of the pipeline.StringgetReservedIpRanges(int index)A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.com.google.protobuf.ByteStringgetReservedIpRangesBytes(int index)A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.intgetReservedIpRangesCount()A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.com.google.protobuf.ProtocolStringListgetReservedIpRangesList()A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.PipelineJob.RuntimeConfiggetRuntimeConfig()Runtime config of the pipeline.PipelineJob.RuntimeConfigOrBuildergetRuntimeConfigOrBuilder()Runtime config of the pipeline.StringgetScheduleName()Output only.com.google.protobuf.ByteStringgetScheduleNameBytes()Output only.intgetSerializedSize()StringgetServiceAccount()The service account that the pipeline workload runs as.com.google.protobuf.ByteStringgetServiceAccountBytes()The service account that the pipeline workload runs as.com.google.protobuf.TimestampgetStartTime()Output only.com.google.protobuf.TimestampOrBuildergetStartTimeOrBuilder()Output only.PipelineStategetState()Output only.intgetStateValue()Output only.PipelineTemplateMetadatagetTemplateMetadata()Output only.PipelineTemplateMetadataOrBuildergetTemplateMetadataOrBuilder()Output only.StringgetTemplateUri()A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.com.google.protobuf.ByteStringgetTemplateUriBytes()A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasEncryptionSpec()Customer-managed encryption key spec for a pipelineJob.booleanhasEndTime()Output only.booleanhasError()Output only.inthashCode()booleanhasJobDetail()Output only.booleanhasPipelineSpec()The spec of the pipeline.booleanhasRuntimeConfig()Runtime config of the pipeline.booleanhasStartTime()Output only.booleanhasTemplateMetadata()Output only.booleanhasUpdateTime()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static PipelineJob.BuildernewBuilder()static PipelineJob.BuildernewBuilder(PipelineJob prototype)PipelineJob.BuildernewBuilderForType()protected PipelineJob.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static PipelineJobparseDelimitedFrom(InputStream input)static PipelineJobparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static PipelineJobparseFrom(byte[] data)static PipelineJobparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static PipelineJobparseFrom(com.google.protobuf.ByteString data)static PipelineJobparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static PipelineJobparseFrom(com.google.protobuf.CodedInputStream input)static PipelineJobparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static PipelineJobparseFrom(InputStream input)static PipelineJobparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static PipelineJobparseFrom(ByteBuffer data)static PipelineJobparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<PipelineJob>parser()PipelineJob.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PIPELINE_SPEC_FIELD_NUMBER
public static final int PIPELINE_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
JOB_DETAIL_FIELD_NUMBER
public static final int JOB_DETAIL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RUNTIME_CONFIG_FIELD_NUMBER
public static final int RUNTIME_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESERVED_IP_RANGES_FIELD_NUMBER
public static final int RESERVED_IP_RANGES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TEMPLATE_URI_FIELD_NUMBER
public static final int TEMPLATE_URI_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TEMPLATE_METADATA_FIELD_NUMBER
public static final int TEMPLATE_METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SCHEDULE_NAME_FIELD_NUMBER
public static final int SCHEDULE_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
public String getName()
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNamein interfacePipelineJobOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNameBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for name.
-
getDisplayName
public String getDisplayName()
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;- Specified by:
getDisplayNamein interfacePipelineJobOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;- Specified by:
getDisplayNameBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for displayName.
-
hasCreateTime
public boolean hasCreateTime()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfacePipelineJobOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfacePipelineJobOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfacePipelineJobOrBuilder
-
hasStartTime
public boolean hasStartTime()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasStartTimein interfacePipelineJobOrBuilder- Returns:
- Whether the startTime field is set.
-
getStartTime
public com.google.protobuf.Timestamp getStartTime()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStartTimein interfacePipelineJobOrBuilder- Returns:
- The startTime.
-
getStartTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStartTimeOrBuilderin interfacePipelineJobOrBuilder
-
hasEndTime
public boolean hasEndTime()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasEndTimein interfacePipelineJobOrBuilder- Returns:
- Whether the endTime field is set.
-
getEndTime
public com.google.protobuf.Timestamp getEndTime()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEndTimein interfacePipelineJobOrBuilder- Returns:
- The endTime.
-
getEndTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEndTimeOrBuilderin interfacePipelineJobOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfacePipelineJobOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfacePipelineJobOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfacePipelineJobOrBuilder
-
hasPipelineSpec
public boolean hasPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;- Specified by:
hasPipelineSpecin interfacePipelineJobOrBuilder- Returns:
- Whether the pipelineSpec field is set.
-
getPipelineSpec
public com.google.protobuf.Struct getPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;- Specified by:
getPipelineSpecin interfacePipelineJobOrBuilder- Returns:
- The pipelineSpec.
-
getPipelineSpecOrBuilder
public com.google.protobuf.StructOrBuilder getPipelineSpecOrBuilder()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;- Specified by:
getPipelineSpecOrBuilderin interfacePipelineJobOrBuilder
-
getStateValue
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfacePipelineJobOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
getState
public PipelineState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfacePipelineJobOrBuilder- Returns:
- The state.
-
hasJobDetail
public boolean hasJobDetail()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasJobDetailin interfacePipelineJobOrBuilder- Returns:
- Whether the jobDetail field is set.
-
getJobDetail
public PipelineJobDetail getJobDetail()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getJobDetailin interfacePipelineJobOrBuilder- Returns:
- The jobDetail.
-
getJobDetailOrBuilder
public PipelineJobDetailOrBuilder getJobDetailOrBuilder()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getJobDetailOrBuilderin interfacePipelineJobOrBuilder
-
hasError
public boolean hasError()
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasErrorin interfacePipelineJobOrBuilder- Returns:
- Whether the error field is set.
-
getError
public com.google.rpc.Status getError()
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getErrorin interfacePipelineJobOrBuilder- Returns:
- The error.
-
getErrorOrBuilder
public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getErrorOrBuilderin interfacePipelineJobOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:PipelineJobOrBuilderThe labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
map<string, string> labels = 11;- Specified by:
getLabelsCountin interfacePipelineJobOrBuilder
-
containsLabels
public boolean containsLabels(String key)
The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
map<string, string> labels = 11;- Specified by:
containsLabelsin interfacePipelineJobOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfacePipelineJobOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
map<string, string> labels = 11;- Specified by:
getLabelsMapin interfacePipelineJobOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
map<string, string> labels = 11;- Specified by:
getLabelsOrDefaultin interfacePipelineJobOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
map<string, string> labels = 11;- Specified by:
getLabelsOrThrowin interfacePipelineJobOrBuilder
-
hasRuntimeConfig
public boolean hasRuntimeConfig()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;- Specified by:
hasRuntimeConfigin interfacePipelineJobOrBuilder- Returns:
- Whether the runtimeConfig field is set.
-
getRuntimeConfig
public PipelineJob.RuntimeConfig getRuntimeConfig()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;- Specified by:
getRuntimeConfigin interfacePipelineJobOrBuilder- Returns:
- The runtimeConfig.
-
getRuntimeConfigOrBuilder
public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;- Specified by:
getRuntimeConfigOrBuilderin interfacePipelineJobOrBuilder
-
hasEncryptionSpec
public boolean hasEncryptionSpec()
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;- Specified by:
hasEncryptionSpecin interfacePipelineJobOrBuilder- Returns:
- Whether the encryptionSpec field is set.
-
getEncryptionSpec
public EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;- Specified by:
getEncryptionSpecin interfacePipelineJobOrBuilder- Returns:
- The encryptionSpec.
-
getEncryptionSpecOrBuilder
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;- Specified by:
getEncryptionSpecOrBuilderin interfacePipelineJobOrBuilder
-
getServiceAccount
public String getServiceAccount()
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
string service_account = 17;- Specified by:
getServiceAccountin interfacePipelineJobOrBuilder- Returns:
- The serviceAccount.
-
getServiceAccountBytes
public com.google.protobuf.ByteString getServiceAccountBytes()
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
string service_account = 17;- Specified by:
getServiceAccountBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for serviceAccount.
-
getNetwork
public String getNetwork()
The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.string network = 18 [(.google.api.resource_reference) = { ... }- Specified by:
getNetworkin interfacePipelineJobOrBuilder- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.ByteString getNetworkBytes()
The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.string network = 18 [(.google.api.resource_reference) = { ... }- Specified by:
getNetworkBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for network.
-
getReservedIpRangesList
public com.google.protobuf.ProtocolStringList getReservedIpRangesList()
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 25;- Specified by:
getReservedIpRangesListin interfacePipelineJobOrBuilder- Returns:
- A list containing the reservedIpRanges.
-
getReservedIpRangesCount
public int getReservedIpRangesCount()
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 25;- Specified by:
getReservedIpRangesCountin interfacePipelineJobOrBuilder- Returns:
- The count of reservedIpRanges.
-
getReservedIpRanges
public String getReservedIpRanges(int index)
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 25;- Specified by:
getReservedIpRangesin interfacePipelineJobOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The reservedIpRanges at the given index.
-
getReservedIpRangesBytes
public com.google.protobuf.ByteString getReservedIpRangesBytes(int index)
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 25;- Specified by:
getReservedIpRangesBytesin interfacePipelineJobOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the reservedIpRanges at the given index.
-
getTemplateUri
public String getTemplateUri()
A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.
string template_uri = 19;- Specified by:
getTemplateUriin interfacePipelineJobOrBuilder- Returns:
- The templateUri.
-
getTemplateUriBytes
public com.google.protobuf.ByteString getTemplateUriBytes()
A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.
string template_uri = 19;- Specified by:
getTemplateUriBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for templateUri.
-
hasTemplateMetadata
public boolean hasTemplateMetadata()
Output only. Pipeline template metadata. Will fill up fields if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasTemplateMetadatain interfacePipelineJobOrBuilder- Returns:
- Whether the templateMetadata field is set.
-
getTemplateMetadata
public PipelineTemplateMetadata getTemplateMetadata()
Output only. Pipeline template metadata. Will fill up fields if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTemplateMetadatain interfacePipelineJobOrBuilder- Returns:
- The templateMetadata.
-
getTemplateMetadataOrBuilder
public PipelineTemplateMetadataOrBuilder getTemplateMetadataOrBuilder()
Output only. Pipeline template metadata. Will fill up fields if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTemplateMetadataOrBuilderin interfacePipelineJobOrBuilder
-
getScheduleName
public String getScheduleName()
Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getScheduleNamein interfacePipelineJobOrBuilder- Returns:
- The scheduleName.
-
getScheduleNameBytes
public com.google.protobuf.ByteString getScheduleNameBytes()
Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getScheduleNameBytesin interfacePipelineJobOrBuilder- Returns:
- The bytes for scheduleName.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static PipelineJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PipelineJob parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static PipelineJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static PipelineJob parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static PipelineJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static PipelineJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static PipelineJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public PipelineJob.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static PipelineJob.Builder newBuilder()
-
newBuilder
public static PipelineJob.Builder newBuilder(PipelineJob prototype)
-
toBuilder
public PipelineJob.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected PipelineJob.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static PipelineJob getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<PipelineJob> parser()
-
getParserForType
public com.google.protobuf.Parser<PipelineJob> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public PipelineJob getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-