target.apidocs.com.google.api.services.compute.model.FirewallPolicy.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







FirewallPolicy (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class FirewallPolicy



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.FirewallPolicy













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class FirewallPolicy
extends com.google.api.client.json.GenericJson
Represents a Firewall Policy resource.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


FirewallPolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


FirewallPolicy
clone() 


byte[]
decodeFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking.



FirewallPolicy
encodeFingerprint(byte[] fingerprint)
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking.



List<FirewallPolicyAssociation>
getAssociations()
A list of associations that belong to this firewall policy.



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



String
getDescription()
An optional description of this resource.



String
getDisplayName()
Deprecated, please use short name instead.



String
getFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking.



BigInteger
getId()
[Output Only] The unique identifier for the resource.



String
getKind()
[Output only] Type of the resource.



String
getName()
Name of the resource.



String
getParent()
[Output Only] The parent of the firewall policy.



String
getRegion()
[Output Only] URL of the region where the regional firewall policy resides.



List<FirewallPolicyRule>
getRules()
A list of rules that belong to this policy.



Integer
getRuleTupleCount()
[Output Only] Total count of all firewall policy rule tuples.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.



String
getShortName()
User-provided name of the Organization firewall policy.



FirewallPolicy
set(String fieldName,
   Object value) 


FirewallPolicy
setAssociations(List<FirewallPolicyAssociation> associations)
A list of associations that belong to this firewall policy.



FirewallPolicy
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



FirewallPolicy
setDescription(String description)
An optional description of this resource.



FirewallPolicy
setDisplayName(String displayName)
Deprecated, please use short name instead.



FirewallPolicy
setFingerprint(String fingerprint)
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking.



FirewallPolicy
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



FirewallPolicy
setKind(String kind)
[Output only] Type of the resource.



FirewallPolicy
setName(String name)
Name of the resource.



FirewallPolicy
setParent(String parent)
[Output Only] The parent of the firewall policy.



FirewallPolicy
setRegion(String region)
[Output Only] URL of the region where the regional firewall policy resides.



FirewallPolicy
setRules(List<FirewallPolicyRule> rules)
A list of rules that belong to this policy.



FirewallPolicy
setRuleTupleCount(Integer ruleTupleCount)
[Output Only] Total count of all firewall policy rule tuples.



FirewallPolicy
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



FirewallPolicy
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.



FirewallPolicy
setShortName(String shortName)
User-provided name of the Organization firewall policy.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





FirewallPolicy
public FirewallPolicy()









Method Detail





getAssociations
public List<FirewallPolicyAssociation> getAssociations()
A list of associations that belong to this firewall policy.

Returns:
value or null for none








setAssociations
public FirewallPolicy setAssociations(List<FirewallPolicyAssociation> associations)
A list of associations that belong to this firewall policy.

Parameters:
associations - associations or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public FirewallPolicy setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public FirewallPolicy setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getDisplayName
public String getDisplayName()
Deprecated, please use short name instead. User-provided name of the Organization firewall
 policy. The name should be unique in the organization in which the firewall policy is created.
 This field is not applicable to network firewall policies. This name must be set on creation
 and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035.
 Specifically, the name must be 1-63 characters long and match the regular expression
 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and
 all following characters must be a dash, lowercase letter, or digit, except the last character,
 which cannot be a dash.

Returns:
value or null for none








setDisplayName
public FirewallPolicy setDisplayName(String displayName)
Deprecated, please use short name instead. User-provided name of the Organization firewall
 policy. The name should be unique in the organization in which the firewall policy is created.
 This field is not applicable to network firewall policies. This name must be set on creation
 and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035.
 Specifically, the name must be 1-63 characters long and match the regular expression
 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and
 all following characters must be a dash, lowercase letter, or digit, except the last character,
 which cannot be a dash.

Parameters:
displayName - displayName or null for none








getFingerprint
public String getFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update metadata. You must always provide an
 up-to-date fingerprint hash in order to update or change metadata, otherwise the request will
 fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the
 firewall policy.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update metadata. You must always provide an
 up-to-date fingerprint hash in order to update or change metadata, otherwise the request will
 fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the
 firewall policy.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public FirewallPolicy setFingerprint(String fingerprint)
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update metadata. You must always provide an
 up-to-date fingerprint hash in order to update or change metadata, otherwise the request will
 fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the
 firewall policy.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public FirewallPolicy encodeFingerprint(byte[] fingerprint)
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's
 contents and used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update metadata. You must always provide an
 up-to-date fingerprint hash in order to update or change metadata, otherwise the request will
 fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the
 firewall policy.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:
value or null for none








setId
public FirewallPolicy setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:
id - id or null for none








getKind
public String getKind()
[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

Returns:
value or null for none








setKind
public FirewallPolicy setKind(String kind)
[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

Parameters:
kind - kind or null for none








getName
public String getName()
Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID
 allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

Returns:
value or null for none








setName
public FirewallPolicy setName(String name)
Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID
 allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

Parameters:
name - name or null for none








getParent
public String getParent()
[Output Only] The parent of the firewall policy. This field is not applicable to network
 firewall policies.

Returns:
value or null for none








setParent
public FirewallPolicy setParent(String parent)
[Output Only] The parent of the firewall policy. This field is not applicable to network
 firewall policies.

Parameters:
parent - parent or null for none








getRegion
public String getRegion()
[Output Only] URL of the region where the regional firewall policy resides. This field is not
 applicable to global firewall policies. You must specify this field as part of the HTTP request
 URL. It is not settable as a field in the request body.

Returns:
value or null for none








setRegion
public FirewallPolicy setRegion(String region)
[Output Only] URL of the region where the regional firewall policy resides. This field is not
 applicable to global firewall policies. You must specify this field as part of the HTTP request
 URL. It is not settable as a field in the request body.

Parameters:
region - region or null for none








getRuleTupleCount
public Integer getRuleTupleCount()
[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed
 a set number of tuples.

Returns:
value or null for none








setRuleTupleCount
public FirewallPolicy setRuleTupleCount(Integer ruleTupleCount)
[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed
 a set number of tuples.

Parameters:
ruleTupleCount - ruleTupleCount or null for none








getRules
public List<FirewallPolicyRule> getRules()
A list of rules that belong to this policy. There must always be a default rule (rule with
 priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a
 default rule with action "allow" will be added.

Returns:
value or null for none








setRules
public FirewallPolicy setRules(List<FirewallPolicyRule> rules)
A list of rules that belong to this policy. There must always be a default rule (rule with
 priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a
 default rule with action "allow" will be added.

Parameters:
rules - rules or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public FirewallPolicy setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getSelfLinkWithId
public String getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.

Returns:
value or null for none








setSelfLinkWithId
public FirewallPolicy setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.

Parameters:
selfLinkWithId - selfLinkWithId or null for none








getShortName
public String getShortName()
User-provided name of the Organization firewall policy. The name should be unique in the
 organization in which the firewall policy is created. This field is not applicable to network
 firewall policies. This name must be set on creation and cannot be changed. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Returns:
value or null for none








setShortName
public FirewallPolicy setShortName(String shortName)
User-provided name of the Organization firewall policy. The name should be unique in the
 organization in which the firewall policy is created. This field is not applicable to network
 firewall policies. This name must be set on creation and cannot be changed. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Parameters:
shortName - shortName or null for none








set
public FirewallPolicy set(String fieldName,
                          Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public FirewallPolicy clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`FirewallPolicy`	`clone()`
`byte[]`	`decodeFingerprint()` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`FirewallPolicy`	`encodeFingerprint(byte[] fingerprint)` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`List<FirewallPolicyAssociation>`	`getAssociations()` A list of associations that belong to this firewall policy.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getDisplayName()` Deprecated, please use short name instead.
`String`	`getFingerprint()` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output only] Type of the resource.
`String`	`getName()` Name of the resource.
`String`	`getParent()` [Output Only] The parent of the firewall policy.
`String`	`getRegion()` [Output Only] URL of the region where the regional firewall policy resides.
`List<FirewallPolicyRule>`	`getRules()` A list of rules that belong to this policy.
`Integer`	`getRuleTupleCount()` [Output Only] Total count of all firewall policy rule tuples.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`String`	`getShortName()` User-provided name of the Organization firewall policy.
`FirewallPolicy`	`set(String fieldName, Object value)`
`FirewallPolicy`	`setAssociations(List<FirewallPolicyAssociation> associations)` A list of associations that belong to this firewall policy.
`FirewallPolicy`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`FirewallPolicy`	`setDescription(String description)` An optional description of this resource.
`FirewallPolicy`	`setDisplayName(String displayName)` Deprecated, please use short name instead.
`FirewallPolicy`	`setFingerprint(String fingerprint)` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`FirewallPolicy`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`FirewallPolicy`	`setKind(String kind)` [Output only] Type of the resource.
`FirewallPolicy`	`setName(String name)` Name of the resource.
`FirewallPolicy`	`setParent(String parent)` [Output Only] The parent of the firewall policy.
`FirewallPolicy`	`setRegion(String region)` [Output Only] URL of the region where the regional firewall policy resides.
`FirewallPolicy`	`setRules(List<FirewallPolicyRule> rules)` A list of rules that belong to this policy.
`FirewallPolicy`	`setRuleTupleCount(Integer ruleTupleCount)` [Output Only] Total count of all firewall policy rule tuples.
`FirewallPolicy`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`FirewallPolicy`	`setSelfLinkWithId(String selfLinkWithId)` [Output Only] Server-defined URL for this resource with the resource id.
`FirewallPolicy`	`setShortName(String shortName)` User-provided name of the Organization firewall policy.