PHPFUI/InstaDoc

The request message to search related account group memberships.

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $project
      Required. The name of the project to search related account group
      memberships from. Specify the project name in the following format:
      `projects/{project}`.
@type string $account_id
      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.
@type string $hashed_account_id
      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.
@type int $page_size
      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.
@type string $page_token
      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.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public static build(string $project, string $hashedAccountId) : self

param string $project 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 {@see \RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
param string $hashedAccountId 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.
return \Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest
experimental

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public 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.

Generated from protobuf field string account_id = 5 [(.google.api.field_behavior) = OPTIONAL];

return string

public 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.

Generated from protobuf field bytes hashed_account_id = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

return string
deprecated

public 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.

Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

return int

public 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.

Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

return string

public getProject()

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

Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

return string

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setAccountId( $var)

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.

Generated from protobuf field string account_id = 5 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setHashedAccountId( $var)

Optional. Deprecated: use account_id instead.

Generated from protobuf field bytes hashed_account_id = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

param string $var
return $this
deprecated

public setPageSize( $var)

Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

param int $var
return $this

public setPageToken( $var)

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.

Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setProject( $var)

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

Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

param string $var
return $this

Properties

protected $account_id = ''

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.

Generated from protobuf field string account_id = 5 [(.google.api.field_behavior) = OPTIONAL];

protected $hashed_account_id = ''

Optional. Deprecated: use account_id instead.

Generated from protobuf field bytes hashed_account_id = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

deprecated

protected $page_size = 0

Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

protected $page_token = ''

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.

Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

protected $project = ''

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

Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Methods

public static build(string $project, string $hashedAccountId) : self

param string $project 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 {@see \RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
param string $hashedAccountId 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.
return \Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest
experimental