com.google.cloud.dataproc.v1

Class ListJobsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.ListJobsRequest

All Implemented Interfaces:

ListJobsRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class ListJobsRequest
extends GeneratedMessageV3
implements ListJobsRequestOrBuilder

 A request to list jobs in a project.
 

Protobuf type google.cloud.dataproc.v1.ListJobsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListJobsRequest.Builder A request to list jobs in a project.
static class	ListJobsRequest.JobStateMatcher A matcher that specifies categories of job states.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_NAME_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	JOB_STATE_MATCHER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PROJECT_ID_FIELD_NUMBER
static int	REGION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClusterName() Optional.
ByteString	getClusterNameBytes() Optional.
static ListJobsRequest	getDefaultInstance()
ListJobsRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getFilter() Optional.
ByteString	getFilterBytes() Optional.
ListJobsRequest.JobStateMatcher	getJobStateMatcher() Optional.
int	getJobStateMatcherValue() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
ByteString	getPageTokenBytes() Optional.
Parser<ListJobsRequest>	getParserForType()
String	getProjectId() Required.
ByteString	getProjectIdBytes() Required.
String	getRegion() Required.
ByteString	getRegionBytes() Required.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListJobsRequest.Builder	newBuilder()
static ListJobsRequest.Builder	newBuilder(ListJobsRequest prototype)
ListJobsRequest.Builder	newBuilderForType()
protected ListJobsRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ListJobsRequest	parseDelimitedFrom(InputStream input)
static ListJobsRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ListJobsRequest	parseFrom(byte[] data)
static ListJobsRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ListJobsRequest	parseFrom(ByteBuffer data)
static ListJobsRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ListJobsRequest	parseFrom(ByteString data)
static ListJobsRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ListJobsRequest	parseFrom(CodedInputStream input)
static ListJobsRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ListJobsRequest	parseFrom(InputStream input)
static ListJobsRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ListJobsRequest>	parser()
ListJobsRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

See Also:

Constant Field Values

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

JOB_STATE_MATCHER_FIELD_NUMBER

public static final int JOB_STATE_MATCHER_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getProjectId

public String getProjectId()

 Required. The ID of the Google Cloud Platform project that the job
 belongs to.
 

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getProjectId in interface ListJobsRequestOrBuilder

Returns:

The projectId.

getProjectIdBytes

public ByteString getProjectIdBytes()

 Required. The ID of the Google Cloud Platform project that the job
 belongs to.
 

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getProjectIdBytes in interface ListJobsRequestOrBuilder

Returns:

The bytes for projectId.

getRegion

public String getRegion()

 Required. The Dataproc region in which to handle the request.
 

string region = 6 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRegion in interface ListJobsRequestOrBuilder

Returns:

The region.

getRegionBytes

public ByteString getRegionBytes()

 Required. The Dataproc region in which to handle the request.
 

string region = 6 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRegionBytes in interface ListJobsRequestOrBuilder

Returns:

The bytes for region.

getPageSize

public int getPageSize()

 Optional. The number of results to return in each response.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageSize in interface ListJobsRequestOrBuilder

Returns:

The pageSize.

getPageToken

public String getPageToken()

 Optional. The page token, returned by a previous call, to request the
 next page of results.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageToken in interface ListJobsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public ByteString getPageTokenBytes()

 Optional. The page token, returned by a previous call, to request the
 next page of results.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageTokenBytes in interface ListJobsRequestOrBuilder

Returns:

The bytes for pageToken.

getClusterName

public String getClusterName()

 Optional. If set, the returned jobs list includes only jobs that were
 submitted to the named cluster.
 

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getClusterName in interface ListJobsRequestOrBuilder

Returns:

The clusterName.

getClusterNameBytes

public ByteString getClusterNameBytes()

 Optional. If set, the returned jobs list includes only jobs that were
 submitted to the named cluster.
 

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getClusterNameBytes in interface ListJobsRequestOrBuilder

Returns:

The bytes for clusterName.

getJobStateMatcherValue

public int getJobStateMatcherValue()

 Optional. Specifies enumerated categories of jobs to list.
 (default = match ALL jobs).
 If `filter` is provided, `jobStateMatcher` will be ignored.
 

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getJobStateMatcherValue in interface ListJobsRequestOrBuilder

Returns:

The enum numeric value on the wire for jobStateMatcher.

getJobStateMatcher

public ListJobsRequest.JobStateMatcher getJobStateMatcher()

 Optional. Specifies enumerated categories of jobs to list.
 (default = match ALL jobs).
 If `filter` is provided, `jobStateMatcher` will be ignored.
 

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getJobStateMatcher in interface ListJobsRequestOrBuilder

Returns:

The jobStateMatcher.

getFilter

public String getFilter()

 Optional. A filter constraining the jobs to list. Filters are
 case-sensitive and have the following syntax:
 [field = value] AND [field [= value]] ...
 where **field** is `status.state` or `labels.[KEY]`, and `[KEY]` is a label
 key. **value** can be `*` to match all values.
 `status.state` can be either `ACTIVE` or `NON_ACTIVE`.
 Only the logical `AND` operator is supported; space-separated items are
 treated as having an implicit `AND` operator.
 Example filter:
 status.state = ACTIVE AND labels.env = staging AND labels.starred = *
 

string filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface ListJobsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public ByteString getFilterBytes()

 Optional. A filter constraining the jobs to list. Filters are
 case-sensitive and have the following syntax:
 [field = value] AND [field [= value]] ...
 where **field** is `status.state` or `labels.[KEY]`, and `[KEY]` is a label
 key. **value** can be `*` to match all values.
 `status.state` can be either `ACTIVE` or `NON_ACTIVE`.
 Only the logical `AND` operator is supported; space-separated items are
 treated as having an implicit `AND` operator.
 Example filter:
 status.state = ACTIVE AND labels.env = staging AND labels.starred = *
 

string filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface ListJobsRequestOrBuilder

Returns:

The bytes for filter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListJobsRequest parseFrom(ByteBuffer data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(ByteBuffer data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(ByteString data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(byte[] data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(byte[] data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListJobsRequest parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static ListJobsRequest parseFrom(InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListJobsRequest parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListJobsRequest parseDelimitedFrom(InputStream input,
                                                 ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static ListJobsRequest parseFrom(CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static ListJobsRequest parseFrom(CodedInputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public ListJobsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListJobsRequest.Builder newBuilder()

newBuilder

public static ListJobsRequest.Builder newBuilder(ListJobsRequest prototype)

toBuilder

public ListJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListJobsRequest getDefaultInstance()

parser

public static Parser<ListJobsRequest> parser()

getParserForType

public Parser<ListJobsRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ListJobsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder