Class SearchPartnerLinksRequest (0.8.0)

public final class SearchPartnerLinksRequest extends GeneratedMessage implements SearchPartnerLinksRequestOrBuilder

Request to search for PartnerLink resources. Returns a SearchPartnerLinksResponse.

Protobuf type google.ads.datamanager.v1.SearchPartnerLinksRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchPartnerLinksRequest getDefaultInstance()
Returns
Type Description
SearchPartnerLinksRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchPartnerLinksRequest.Builder newBuilder()
Returns
Type Description
SearchPartnerLinksRequest.Builder

newBuilder(SearchPartnerLinksRequest prototype)

public static SearchPartnerLinksRequest.Builder newBuilder(SearchPartnerLinksRequest prototype)
Parameter
Name Description
prototype SearchPartnerLinksRequest
Returns
Type Description
SearchPartnerLinksRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchPartnerLinksRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchPartnerLinksRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchPartnerLinksRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchPartnerLinksRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchPartnerLinksRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchPartnerLinksRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchPartnerLinksRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchPartnerLinksRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchPartnerLinksRequest> parser()
Returns
Type Description
Parser<SearchPartnerLinksRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchPartnerLinksRequest getDefaultInstanceForType()
Returns
Type Description
SearchPartnerLinksRequest

getFilter()

public String getFilter()

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported operations:

  • AND
  • =
  • !=

    Supported fields:

  • partner_link_id

  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id

    Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported operations:

  • AND
  • =
  • !=

    Supported fields:

  • partner_link_id

  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id

    Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<SearchPartnerLinksRequest> getParserForType()
Returns
Type Description
Parser<SearchPartnerLinksRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchPartnerLinksRequest.Builder newBuilderForType()
Returns
Type Description
SearchPartnerLinksRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchPartnerLinksRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchPartnerLinksRequest.Builder
Overrides

toBuilder()

public SearchPartnerLinksRequest.Builder toBuilder()
Returns
Type Description
SearchPartnerLinksRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException