Google Cloud Recaptcha Enterprise V1 Client - Class SearchRelatedAccountGroupMembershipsRequest (1.12.2)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class SearchRelatedAccountGroupMembershipsRequest.

The request message to search related account group memberships.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ project`	`string` Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`.
`↳ account_id`	`string` Optional. The unique stable account identifier used to search connections. The identifier should correspond to an `account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`↳ hashed_account_id`	`string` Optional. Deprecated: use `account_id` instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`↳ page_size`	`int` Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
`↳ page_token`	`string` Optional. A page token, received from a previous `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchRelatedAccountGroupMemberships` must match the call that provided the page token.

getProject

Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

Returns
Type	Description
`string`

setProject

Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAccountId

Optional. The unique stable account identifier used to search connections.

The identifier should correspond to an account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

Returns
Type	Description
`string`

setAccountId

Optional. The unique stable account identifier used to search connections.

The identifier should correspond to an account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHashedAccountId

Optional. Deprecated: use account_id instead.

The unique stable hashed account identifier used to search connections. The identifier should correspond to a hashed_account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

Returns
Type	Description
`string`

setHashedAccountId

Optional. Deprecated: use account_id instead.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Returns
Type	Description
`int`

setPageSize

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

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

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

Returns
Type	Description
`string`

setPageToken

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

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`project`	`string` Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`. Please see Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient::projectName() for help formatting this field.
`hashedAccountId`	`string` Optional. Deprecated: use `account_id` instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest`