Class ListMigrationJobsRequest.Builder (2.8.0)

public static final class ListMigrationJobsRequest.Builder extends GeneratedMessageV3.Builder<ListMigrationJobsRequest.Builder> implements ListMigrationJobsRequestOrBuilder

Retrieve a list of all migration jobs in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListMigrationJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListMigrationJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

build()

public ListMigrationJobsRequest build()
Returns
TypeDescription
ListMigrationJobsRequest

buildPartial()

public ListMigrationJobsRequest buildPartial()
Returns
TypeDescription
ListMigrationJobsRequest

clear()

public ListMigrationJobsRequest.Builder clear()
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListMigrationJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

clearFilter()

public ListMigrationJobsRequest.Builder clearFilter()

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

string filter = 4;

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListMigrationJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

clearOrderBy()

public ListMigrationJobsRequest.Builder clearOrderBy()

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

string order_by = 5;

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

clearPageSize()

public ListMigrationJobsRequest.Builder clearPageSize()

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListMigrationJobsRequest.Builder clearPageToken()

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

clearParent()

public ListMigrationJobsRequest.Builder clearParent()

Required. The parent, which owns this collection of migrationJobs.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

clone()

public ListMigrationJobsRequest.Builder clone()
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListMigrationJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListMigrationJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

string order_by = 5;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

string order_by = 5;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which owns this collection of migrationJobs.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which owns this collection of migrationJobs.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListMigrationJobsRequest other)

public ListMigrationJobsRequest.Builder mergeFrom(ListMigrationJobsRequest other)
Parameter
NameDescription
otherListMigrationJobsRequest
Returns
TypeDescription
ListMigrationJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListMigrationJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListMigrationJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListMigrationJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListMigrationJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

setFilter(String value)

public ListMigrationJobsRequest.Builder setFilter(String value)

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListMigrationJobsRequest.Builder setFilterBytes(ByteString value)

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListMigrationJobsRequest.Builder setOrderBy(String value)

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListMigrationJobsRequest.Builder setOrderByBytes(ByteString value)

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

string order_by = 5;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListMigrationJobsRequest.Builder setPageSize(int value)

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListMigrationJobsRequest.Builder setPageToken(String value)

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListMigrationJobsRequest.Builder setPageTokenBytes(ByteString value)

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListMigrationJobsRequest.Builder setParent(String value)

Required. The parent, which owns this collection of migrationJobs.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListMigrationJobsRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of migrationJobs.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListMigrationJobsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListMigrationJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListMigrationJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListMigrationJobsRequest.Builder
Overrides