Represents an AccessFilter.
Package
@google-analytics/adminConstructors
(constructor)(properties)
constructor(properties?: google.analytics.admin.v1beta.IAccessFilter);Constructs a new AccessFilter.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAccessFilter
Properties to set |
Properties
betweenFilter
public betweenFilter?: (google.analytics.admin.v1beta.IAccessBetweenFilter|null);AccessFilter betweenFilter.
fieldName
public fieldName: string;AccessFilter fieldName.
inListFilter
public inListFilter?: (google.analytics.admin.v1beta.IAccessInListFilter|null);AccessFilter inListFilter.
numericFilter
public numericFilter?: (google.analytics.admin.v1beta.IAccessNumericFilter|null);AccessFilter numericFilter.
oneFilter
public oneFilter?: ("stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter");AccessFilter oneFilter.
stringFilter
public stringFilter?: (google.analytics.admin.v1beta.IAccessStringFilter|null);AccessFilter stringFilter.
Methods
create(properties)
public static create(properties?: google.analytics.admin.v1beta.IAccessFilter): google.analytics.admin.v1beta.AccessFilter;Creates a new AccessFilter instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAccessFilter
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AccessFilter | AccessFilter instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1beta.AccessFilter;Decodes an AccessFilter message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AccessFilter | AccessFilter |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1beta.AccessFilter;Decodes an AccessFilter message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AccessFilter | AccessFilter |
encode(message, writer)
public static encode(message: google.analytics.admin.v1beta.IAccessFilter, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AccessFilter message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAccessFilter
AccessFilter message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.analytics.admin.v1beta.IAccessFilter, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AccessFilter message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAccessFilter
AccessFilter message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1beta.AccessFilter;Creates an AccessFilter message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
AccessFilter | AccessFilter |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AccessFilter
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AccessFilter to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.analytics.admin.v1beta.AccessFilter, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AccessFilter message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AccessFilter
AccessFilter |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AccessFilter message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|